Reviewpad Documentation

This repo contains the source powering up docs.reviewpad.com

Warning

When updating the documentation you only need to update the files inside the docs folder. The files under versioned_docs and versioned_sidebars are automatically generated.

Getting started

Prerequisites

1. Git
2. Nodejs: version v16.14.0 or greater
3. Yarn v1: See Yarn website for installation instructions
4. A fork of the repo (for any contributions)
5. A clone of the reviewpad/docs repo on your local machine

Installation

1. Navigate into the project root

cd docs

3. Install the website's npm dependencies

yarn

Running locally

1. Start a local development server

yarn start

Note

You browser should open automatically. If that's not the case please navigate to http://localhost:3000.

Note

Most changes are reflected live without having to restart the server.

Contributing

Set up IDE

We strongly recommend using Visual Studio Code as your IDE.

Install extensions

• EditorConfig for VS Code for consistent coding styles
• MDX for syntax highlighting on MDX files
• YAML for enabling reviewpad.yml JSON schema.

Configure VSCode

Open the project in VSCode, open the command palette (Ctrl+Shift+P) and search for Preferences: Open Workspace Settings (JSON).

Paste the following configuration:

{
    "editor.formatOnPaste": true,
    "editor.formatOnSave": true,
    "files.autoSave": "onFocusChange"
}

Create a branch

1. Checkout the main branch from any folder in your local docs.reviewpad.com repository

git checkout main

2. Ensure you have the latest main code

git pull origin main

3. Create a new branch

git checkout -b THE-NAME-OF-MY-BRANCH

Warning

Please replace THE-NAME-OF-MY-BRANCH with a suitable name for your branch

Make the change

1. Follow the "Running locally" instructions
2. Save the files and check in the browser

Warning

When updating the documentation you only need to update the files inside the docs folder. The files under versioned_docs and versioned_sidebars are automatically generated.

Test the change

If possible, test any visual changes in all latest versions of common browsers, on both desktop and mobile.

Push it

1. Stage and commit your changes

git add -A && git commit -m "MY MESSAGE"

Warning

Please replace MY MESSAGE with a conventional commit message, such as fix: typo on installation section

2. Push your changes

git push MY-FORK-NAME THE-NAME-OF-MY-BRANCH

Warning

Please replace MY-FORK-NAME with the name of your fork Please replace THE-NAME-OF-MY-BRANCH with the name of your branch

3. Go to the reviewpad/docs repo and you should see recently pushed branches.

4. Follow GitHub's instructions.

5. If possible, include screenshots of visual changes. A preview build is triggered after your pull request is opened.

Note

After a pull request is created, a preview is built automatically.

Troubleshooting

• yarn reset to clear the local cache

Reach out

If you have any questions, please reach out to us at our Discord community 💪

License

This project is licensed under GNU Lesser General Public License v3.0