You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-**Assistant ID**: The `runllm-assistant-id` is currently set to "YOUR_ASSISTANT_ID" and needs to be updated with the actual Sourcegraph runLLM assistant ID
53
-
-**Deployment**: After updating the assistant ID, add the deployment URL to the runLLM dashboard
54
-
-**Styling**: The widget inherits the site's theme and uses the Sourcegraph brand color (#FF5543)
53
+
-**Assistant ID**: The `runllm-assistant-id` is currently set to "YOUR_ASSISTANT_ID" and needs to be updated with the actual Sourcegraph runLLM assistant ID
54
+
-**Deployment**: After updating the assistant ID, add the deployment URL to the runLLM dashboard
55
+
-**Styling**: The widget inherits the site's theme and uses the Sourcegraph brand color (#FF5543)
Copy file name to clipboardExpand all lines: README.md
+18-16Lines changed: 18 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,8 +22,8 @@ cd docs
22
22
23
23
Before the dependencies are installed make sure your local machine has the following versions of `node` and `pnpm` installed:
24
24
25
-
* node: `v20.8.1`
26
-
* pnpm: `8.13.1`
25
+
- node: `v20.8.1`
26
+
- pnpm: `8.13.1`
27
27
28
28
**Note**: If you have `mise` available you can install the above versions for only this repository by running the following command from your terminal in the root folder:
29
29
@@ -48,6 +48,7 @@ Finally, open [`http://localhost:3000`](http://localhost:3000) in your browser t
48
48
## Writing and contributing to Sourcegraph Docs
49
49
50
50
### (Easy) Using GitHub to edit existing files
51
+
51
52
You can easily update existing docs pages using [GitHub's file editor](https://docs.github.com/en/repositories/working-with-files/managing-files/editing-files). All you need to do is:
52
53
53
54
1. Find the corresponding `.mdx` file in the [folder structure](#folder-structure).
@@ -58,9 +59,10 @@ You can easily update existing docs pages using [GitHub's file editor](https://d
58
59
6. Click on the green "Propose changes" button to create a PR.
59
60
7. Add a PR reviewer to the Reviewers panel by clicking on the gear icon.
60
61
8. Tag `@maedahbatool` in the `#docs` Slack channel and link to your PR to get a quick review.
61
-
> NOTE: "Edit from GitHub" is generally recommended for text-based edits. For more structural-based contributions like adding React components and code blocks, it's always better to go with a local setup. This way, you can preview changes before you commit.
62
+
> NOTE: "Edit from GitHub" is generally recommended for text-based edits. For more structural-based contributions like adding React components and code blocks, it's always better to go with a local setup. This way, you can preview changes before you commit.
62
63
63
64
### (Advanced) Local dev environment
65
+
64
66
To add new or update existing docs content. Create a new branch and checkout by via:
65
67
66
68
```sh
@@ -71,8 +73,8 @@ git switch -c BRANCH_NAME_HERE
71
73
72
74
The folder structure is exactly the same here. All the docs reside within the `/docs` folder. Here you'll find separate folders for every docs section like `cody`, `code_search`, `cli`, etc.
73
75
74
-
- Navigate to the relevant relevant section for your contribution
75
-
- If you're adding a new page, create a new MDX file (e.g., `my-new-page.mdx`) in the appropriate folder
76
+
-Navigate to the relevant relevant section for your contribution
77
+
-If you're adding a new page, create a new MDX file (e.g., `my-new-page.mdx`) in the appropriate folder
76
78
77
79
### Using MDX
78
80
@@ -115,25 +117,25 @@ This snippet creates a single `<QuickLink>` titled as "Get Cody". You can add as
115
117
116
118
Here are the list of all the supported components we have:
117
119
118
-
-`<QuickLinks>`
119
-
-`<ProductLinks>`
120
-
-`<LinkCards>`
121
-
-`<Callout>`
120
+
-`<QuickLinks>`
121
+
-`<ProductLinks>`
122
+
-`<LinkCards>`
123
+
-`<Callout>`
122
124
123
125
For a better docs experience, we'll continue adding more components in the future.
124
126
125
127
### Adding a link
126
128
127
129
To add a `link` to any docs page, use the following routing syntax: `[Link text](path-to-link)`.
128
130
129
-
- Do not include `/docs` in the link paths. The base URL will be `sourcegraph.com/docs`
130
-
- There should be **no file extension** in the path name
131
+
-Do not include `/docs` in the link paths. The base URL will be `sourcegraph.com/docs`
132
+
-There should be **no file extension** in the path name
131
133
132
134
For example, if you want to link to the Cody Quickstart somewhere in the Code Search docs, you should use:
133
135
134
136
```markdown
135
-
- This is a link to [Cody Quickstart](/cody/quickstart) in Code Search docs
136
-
- This is a way to hash-link to [Cody for VSCode installation](/cody/clients/install-vscode#verifying-the-installation) in Code Search docs
137
+
- This is a link to [Cody Quickstart](/cody/quickstart) in Code Search docs
138
+
- This is a way to hash-link to [Cody for VSCode installation](/cody/clients/install-vscode#verifying-the-installation) in Code Search docs
137
139
```
138
140
139
141
### Adding media assets (images, videos and gifs)
@@ -158,8 +160,8 @@ When you open a PR Vercel deploys and provides you with a preview deployment lin
158
160
159
161
Once you're satisfied with your changes, follow these steps:
160
162
161
-
- Commit your changes
162
-
- Create a pull request to the [Sourcegraph documentation repository](https://github.com/sourcegraph/docs).
163
-
- Tag `@maedahbatool` in `#docs` channel through Slack to get a quick review
163
+
-Commit your changes
164
+
-Create a pull request to the [Sourcegraph documentation repository](https://github.com/sourcegraph/docs).
165
+
-Tag `@maedahbatool` in `#docs` channel through Slack to get a quick review
164
166
165
167
Thank you for contributing to Sourcegraph documentation! Your efforts help us provide top-notch learning experiences for our users. If you have any questions or need assistance, feel free to reach out.
0 commit comments