Welcome to the Sourcegraph documentation! We're excited to have you contribute to our docs. We've recently rearchitectured our docs tech stack — powered by Next.js, TailwindCSS and deployed on Vercel. This guide will walk you through the process of contributing to our documentation using the new tech stack.
To get started with this template, clone this repository to your local machine using the following command:
git clone https://github.com/sourcegraph/docs.git sourcegraph-docsNavigate to the project directory by typing the following command in your terminal:
cd sourcegraph-docsBefore the dependencies are install make sure your local machine has the following versions of node and pnpm:
- node:
v20.8.1 - pnpm:
8.13.1
Note: If you have asdf available you can install the above versions for only this repository by running the following command from your terminal in the root folder:
asdf installNow that the base requirements of the project have been satisfied, we can install the required dependencies to run the development server!
pnpm installNext, run the development server:
pnpm run devFinally, open http://localhost:3000 in your browser to view the website.
You can easily update existing docs pages using GitHub's file editor. All you need to do is:
- Find the corresponding
.mdxfile in the folder structure. - Click the pencil icon to open the file editor.
- Make your changes.
- Click on the green "Commit changes..." button.
- Provide a Commit message and an Extended description.
- Click on the green "Propose changes" button to create a PR.
- Add a PR reviewer to the Reviewers panel by clicking on the gear icon.
- Tag
@maedahbatoolin the#docsSlack channel and link to your PR to get a quick review.
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.
To add new or update existing docs content. Create a new branch and checkout by via:
git switch -c BRANCH_NAME_HEREThe 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.
- Navigate to the relevant relevant section for your contribution
- If you're adding a new page, create a new MDX file (e.g.,
my-new-page.mdx) in the appropriate folder
We use MDX for our documentation, which allows you to seamlessly integrate JSX (React components) within Markdown. Write your content using standard markdown syntax. For example,
# This is heading 1
This is an introductory paragraph.
## This is heading 2
### This is heading 3
These are the details for heading three.
This is how you add a [demo-link](https://sourcegraph.com/)
- This is a bullet 1
- This is bullet 2
- This is bullet 3
The only difference with this new stack is its ability to use React components. We have a set of reusable React components located in the src/components directory. These components are designed to enhance the user experience and maintain consistency across our documentation.
For example the cards layout appears by using the <Callout> component that can add note, info, or warning notices in docs.
You can use this component within your content as follows:
<Callout type="note">Cody is currently in Beta for all users.</Callout>This snippet creates a single <QuickLink> titled as "Get Cody". You can add as many cards you want while filling out all the relevant details.
Here are the list of all the supported components we have:
<QuickLinks><ProductLinks><LinkCards><Callout>
For a better docs experience, we'll continue adding more components in the future.
To add a link to any docs page, use the following routing syntax: [Link text](path-to-link).
- Do not include
/docsin the link paths. The base URL will besourcegraph.com/docs - There should be no file extension in the path name
For example, if you want to link to the Cody Quickstart somewhere in the Code Search docs, you should use:
- This is a link to [Cody Quickstart](/cody/quickstart) in Code Search docs
- This is a way to hash-link to [Cody for VSCode installation](/cody/clients/install-vscode#verifying-the-installation) in Code Search docsYou can upload images, videos and gifs to Sourcegraph docs. For a more detailed instructions visit this page.
Note: Make sure to use ImageOptim.app to reduce the size of the images before uploading, since large images degrade page loading speed.
As you make changes to the documentation, the development server will automatically update. Review your changes by navigating to http://localhost:3000 in your browser.
When you open a PR Vercel deploys and provides you with a preview deployment link. To view your deployment, click the "Visit Preview" and then append /docs at the end of the URL. The original link gives you a 404.
Once you're satisfied with your changes, follow these steps:
- Commit your changes
- Create a pull request to the Sourcegraph documentation repository.
- Tag
@maedahbatoolin#docschannel through Slack to get a quick review
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.