Skip to content

Commit 4756257

Browse files
jsjoeiojsjoeio
committed
refactor: rename doc to docs
1 parent 4c6ad04 commit 4756257

19 files changed

+30
-28
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ assignees: ""
77
---
88

99
<!--
10-
Please see https://github.com/cdr/code-server/blob/master/doc/FAQ.md#how-do-i-debug-issues-with-code-server
10+
Please see https://github.com/cdr/code-server/blob/master/docs/FAQ.md#how-do-i-debug-issues-with-code-server
1111
and include any logging information relevant to the issue.
1212
1313
Please search for existing issues before filing.

‎.github/ISSUE_TEMPLATE/extension-request.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ assignees: ""
99
<!--
1010
Details on the code-server extension marketplace are at
1111
12-
https://github.com/cdr/code-server/blob/master/doc/FAQ.md#whats-the-deal-with-extensions
12+
https://github.com/cdr/code-server/blob/master/docs/FAQ.md#whats-the-deal-with-extensions
1313
1414
Please fill in the issue template!
1515
-->

‎.gitignore

+2-1
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,5 @@ node-*
1414
/plugins
1515
/lib/coder-cloud-agent
1616
.home
17-
coverage
17+
coverage
18+
**/.DS_Store

‎.tours/contributing.tour

+5-5
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
{
5151
"file": "src/node/heart.ts",
5252
"line": 7,
53-
"description": "code-server's heart beats to indicate recent activity.\n\nAlso documented here: [https://github.com/cdr/code-server/blob/master/doc/FAQ.md#heartbeat-file](https://github.com/cdr/code-server/blob/master/doc/FAQ.md#heartbeat-file)"
53+
"description": "code-server's heart beats to indicate recent activity.\n\nAlso documented here: [https://github.com/cdr/code-server/blob/master/docs/FAQ.md#heartbeat-file](https://github.com/cdr/code-server/blob/master/docs/FAQ.md#heartbeat-file)"
5454
},
5555
{
5656
"file": "src/node/socket.ts",
@@ -80,12 +80,12 @@
8080
{
8181
"file": "src/node/routes/domainProxy.ts",
8282
"line": 18,
83-
"description": "code-server provides a built-in proxy to help in developing web-based applications. This is the code for the domain-based proxy.\n\nAlso documented here: [https://github.com/cdr/code-server/blob/master/doc/FAQ.md#how-do-i-securely-access-web-services](https://github.com/cdr/code-server/blob/master/doc/FAQ.md#how-do-i-securely-access-web-services)"
83+
"description": "code-server provides a built-in proxy to help in developing web-based applications. This is the code for the domain-based proxy.\n\nAlso documented here: [https://github.com/cdr/code-server/blob/master/docs/FAQ.md#how-do-i-securely-access-web-services](https://github.com/cdr/code-server/blob/master/docs/FAQ.md#how-do-i-securely-access-web-services)"
8484
},
8585
{
8686
"file": "src/node/routes/pathProxy.ts",
8787
"line": 19,
88-
"description": "Here is the path-based version of the proxy.\n\nAlso documented here: [https://github.com/cdr/code-server/blob/master/doc/FAQ.md#how-do-i-securely-access-web-services](https://github.com/cdr/code-server/blob/master/doc/FAQ.md#how-do-i-securely-access-web-services)"
88+
"description": "Here is the path-based version of the proxy.\n\nAlso documented here: [https://github.com/cdr/code-server/blob/master/docs/FAQ.md#how-do-i-securely-access-web-services](https://github.com/cdr/code-server/blob/master/docs/FAQ.md#how-do-i-securely-access-web-services)"
8989
},
9090
{
9191
"file": "src/node/proxy.ts",
@@ -95,7 +95,7 @@
9595
{
9696
"file": "src/node/routes/health.ts",
9797
"line": 5,
98-
"description": "A simple endpoint that lets you see if code-server is up.\n\nAlso documented here: [https://github.com/cdr/code-server/blob/master/doc/FAQ.md#healthz-endpoint](https://github.com/cdr/code-server/blob/master/doc/FAQ.md#healthz-endpoint)"
98+
"description": "A simple endpoint that lets you see if code-server is up.\n\nAlso documented here: [https://github.com/cdr/code-server/blob/master/docs/FAQ.md#healthz-endpoint](https://github.com/cdr/code-server/blob/master/docs/FAQ.md#healthz-endpoint)"
9999
},
100100
{
101101
"file": "src/node/routes/login.ts",
@@ -145,7 +145,7 @@
145145
{
146146
"directory": "lib/vscode",
147147
"line": 1,
148-
"description": "code-server makes use of VS Code's frontend web/remote support. Most of the modifications implement the remote server since that portion of the code is closed source and not released with VS Code.\n\nWe also have a few bug fixes and have added some features (like client-side extensions). See [https://github.com/cdr/code-server/blob/master/doc/CONTRIBUTING.md#modifications-to-vs-code](https://github.com/cdr/code-server/blob/master/doc/CONTRIBUTING.md#modifications-to-vs-code) for a list.\n\nWe make an effort to keep the modifications as few as possible."
148+
"description": "code-server makes use of VS Code's frontend web/remote support. Most of the modifications implement the remote server since that portion of the code is closed source and not released with VS Code.\n\nWe also have a few bug fixes and have added some features (like client-side extensions). See [https://github.com/cdr/code-server/blob/master/docs/CONTRIBUTING.md#modifications-to-vs-code](https://github.com/cdr/code-server/blob/master/docs/CONTRIBUTING.md#modifications-to-vs-code) for a list.\n\nWe make an effort to keep the modifications as few as possible."
149149
}
150150
]
151151
}

‎.tours/start-development.tour

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
{
2121
"file": "src/node/app.ts",
2222
"line": 62,
23-
"description": "## That's it!\n\n\nThat's all there is to it! When this tour ends, your terminal session may stop, but just use `yarn watch` to start developing from here on out!\n\n\nIf you haven't already, be sure to check out these resources:\n- [Tour: Contributing](command:codetour.startTourByTitle?[\"Contributing\")\n- [Docs: FAQ.md](https://github.com/cdr/code-server/blob/master/doc/FAQ.md)\n- [Docs: CONTRIBUTING.md](https://github.com/cdr/code-server/blob/master/doc/CONTRIBUTING.md)\n- [Community: GitHub Discussions](https://github.com/cdr/code-server/discussions)\n- [Community: Slack](https://community.coder.com)"
23+
"description": "## That's it!\n\n\nThat's all there is to it! When this tour ends, your terminal session may stop, but just use `yarn watch` to start developing from here on out!\n\n\nIf you haven't already, be sure to check out these resources:\n- [Tour: Contributing](command:codetour.startTourByTitle?[\"Contributing\")\n- [Docs: FAQ.md](https://github.com/cdr/code-server/blob/master/docs/FAQ.md)\n- [Docs: CONTRIBUTING.md](https://github.com/cdr/code-server/blob/master/docs/CONTRIBUTING.md)\n- [Community: GitHub Discussions](https://github.com/cdr/code-server/discussions)\n- [Community: Slack](https://community.coder.com)"
2424
}
2525
]
2626
}

‎README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and access it in the browser.
66

7-
![Screenshot](./doc/assets/screenshot.png)
7+
![Screenshot](./docs/assets/screenshot.png)
88

99
## Highlights
1010

@@ -17,7 +17,7 @@ Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and a
1717
There are two ways to get started:
1818

1919
1. Using the [install script](./install.sh), which automates most of the process. The script uses the system package manager (if possible)
20-
2. Manually installing code-server; see [Installation](./doc/install.md) for instructions applicable to most use cases
20+
2. Manually installing code-server; see [Installation](./docs/install.md) for instructions applicable to most use cases
2121

2222
If you choose to use the install script, you can preview what occurs during the install process:
2323

@@ -33,7 +33,7 @@ curl -fsSL https://code-server.dev/install.sh | sh
3333

3434
When done, the install script prints out instructions for running and starting code-server.
3535

36-
We also have an in-depth [setup and configuration](./doc/guide.md) guide.
36+
We also have an in-depth [setup and configuration](./docs/guide.md) guide.
3737

3838
### Cloud Program ☁️
3939

@@ -51,11 +51,11 @@ Proxying code-server to Coder Cloud, you can access your IDE at https://valmar-j
5151

5252
## FAQ
5353

54-
See [./doc/FAQ.md](./doc/FAQ.md).
54+
See [./docs/FAQ.md](./docs/FAQ.md).
5555

5656
## Want to help?
5757

58-
See [CONTRIBUTING](./doc/CONTRIBUTING.md) for details.
58+
See [CONTRIBUTING](./docs/CONTRIBUTING.md) for details.
5959

6060
## Hiring
6161

‎ci/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Make sure you have `$GITHUB_TOKEN` set and [hub](https://github.com/github/hub)
1616

1717
1. Update the version of code-server and make a PR.
1818
1. Update in `package.json`
19-
2. Update in [./doc/install.md](../doc/install.md)
19+
2. Update in [./docs/install.md](../docs/install.md)
2020
3. Update in [./ci/helm-chart/README.md](../ci/helm-chart/README.md)
2121
- Remember to update the chart version as well on top of appVersion in `Chart.yaml`.
2222
- Run `rg -g '!yarn.lock' -g '!*.svg' '3\.7\.5'` to ensure all values have been
@@ -62,7 +62,7 @@ NOTE: we have to manually change the color because the default is red if coverag
6262
This directory contains scripts used for the development of code-server.
6363

6464
- [./ci/dev/image](./dev/image)
65-
- See [./doc/CONTRIBUTING.md](../doc/CONTRIBUTING.md) for docs on the development container.
65+
- See [./docs/CONTRIBUTING.md](../docs/CONTRIBUTING.md) for docs on the development container.
6666
- [./ci/dev/fmt.sh](./dev/fmt.sh) (`yarn fmt`)
6767
- Runs formatters.
6868
- [./ci/dev/lint.sh](./dev/lint.sh) (`yarn lint`)
@@ -73,7 +73,7 @@ This directory contains scripts used for the development of code-server.
7373
- Runs `yarn fmt`, `yarn lint` and `yarn test`.
7474
- [./ci/dev/watch.ts](./dev/watch.ts) (`yarn watch`)
7575
- Starts a process to build and launch code-server and restart on any code changes.
76-
- Example usage in [./doc/CONTRIBUTING.md](../doc/CONTRIBUTING.md).
76+
- Example usage in [./docs/CONTRIBUTING.md](../docs/CONTRIBUTING.md).
7777
- [./ci/dev/gen_icons.sh](./ci/dev/gen_icons.sh) (`yarn icons`)
7878
- Generates the various icons from a single `.svg` favicon in
7979
`src/browser/media/favicon.svg`.

‎ci/build/npm-postinstall.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ main() {
3333

3434
if ! vscode_yarn; then
3535
echo "You may not have the required dependencies to build the native modules."
36-
echo "Please see https://github.com/cdr/code-server/blob/master/doc/npm.md"
36+
echo "Please see https://github.com/cdr/code-server/blob/master/docs/npm.md"
3737
exit 1
3838
fi
3939
}

‎ci/build/release-github-draft.sh

+1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ maintains all user data in \`~/.local/share/code-server\` so that it is preserve
2020
installations.
2121
2222
## New Features
23+
2324
- ⭐ Summarize new features here with references to issues
2425
2526
## Bug Fixes

‎ci/dev/fmt.sh

+6-6
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@ main() {
2323
git ls-files "${prettierExts[@]}" | grep -v "lib/vscode" | grep -v 'helm-chart'
2424
)
2525

26-
doctoc --title '# FAQ' doc/FAQ.md > /dev/null
27-
doctoc --title '# Setup Guide' doc/guide.md > /dev/null
28-
doctoc --title '# Install' doc/install.md > /dev/null
29-
doctoc --title '# npm Install Requirements' doc/npm.md > /dev/null
30-
doctoc --title '# Contributing' doc/CONTRIBUTING.md > /dev/null
31-
doctoc --title '# iPad' doc/ipad.md > /dev/null
26+
doctoc --title '# FAQ' docs/FAQ.md > /dev/null
27+
doctoc --title '# Setup Guide' docs/guide.md > /dev/null
28+
doctoc --title '# Install' docs/install.md > /dev/null
29+
doctoc --title '# npm Install Requirements' docs/npm.md > /dev/null
30+
doctoc --title '# Contributing' docs/CONTRIBUTING.md > /dev/null
31+
doctoc --title '# iPad' docs/ipad.md > /dev/null
3232

3333
if [[ ${CI-} && $(git ls-files --other --modified --exclude-standard) ]]; then
3434
echo "Files need generation or are formatted incorrectly:"

‎doc/CONTRIBUTING.md renamed to ‎docs/CONTRIBUTING.md

File renamed without changes.

‎doc/FAQ.md renamed to ‎docs/FAQ.md

File renamed without changes.

‎doc/assets/screenshot.png renamed to ‎docs/assets/screenshot.png

File renamed without changes.

‎doc/guide.md renamed to ‎docs/guide.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ To reiterate, `code-server` lets you run VS Code on a remote server and then acc
2222
Further docs are at:
2323

2424
- [README](../README.md) for a general overview
25-
- [INSTALL](../doc/install.md) for installation
25+
- [INSTALL](../docs/install.md) for installation
2626
- [FAQ](./FAQ.md) for common questions.
27-
- [CONTRIBUTING](../doc/CONTRIBUTING.md) for development docs
27+
- [CONTRIBUTING](../docs/CONTRIBUTING.md) for development docs
2828

2929
We highly recommend reading the [FAQ](./FAQ.md) on the [Differences compared to VS Code](./FAQ.md#differences-compared-to-vs-code) before beginning.
3030

‎doc/install.md renamed to ‎docs/install.md

File renamed without changes.

‎doc/ipad.md renamed to ‎docs/ipad.md

File renamed without changes.

‎doc/npm.md renamed to ‎docs/npm.md

File renamed without changes.

‎doc/triage.md renamed to ‎docs/triage.md

File renamed without changes.

‎install.sh

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
set -eu
33

44
# code-server's automatic install script.
5-
# See https://github.com/cdr/code-server/blob/master/doc/install.md
5+
# See https://github.com/cdr/code-server/blob/master/docs/install.md
66

77
usage() {
88
arg0="$0"
@@ -67,7 +67,7 @@ Usage:
6767
6868
It will cache all downloaded assets into ~/.cache/code-server
6969
70-
More installation docs are at https://github.com/cdr/code-server/blob/master/doc/install.md
70+
More installation docs are at https://github.com/cdr/code-server/blob/master/docs/install.md
7171
EOF
7272
}
7373

0 commit comments

Comments
 (0)