Contribute

We welcome contributions to the Judge0 documentation! Whether you’re fixing typos, adding new content, or improving existing sections, your help is greatly appreciated.

Instructions

1. Install uv.

2. Fork the repository on GitHub.

3. Clone your forked repository.

4. Navigate to the docs directory and install the dependencies.

   cd docs
   uv sync
   

5. Add your content using reStructuredText syntax. See the reStructuredText documentation for details or any of the following resources:

   • A ReStructuredText Primer

   • Quick reStructuredText

   • The reStructuredText_ Cheat Sheet: Syntax Reminders

6. Start a live preview server to see your changes in real-time.

   uv run make livehtml
   

7. Open your web browser and navigate to http://localhost:8000 to view the documentation.

8. Commit and push your changes to your forked repository.

9. Create a pull request to the main repository.

Adding Packages

To add a new package, use the following command:

uv add <package-name> # e.g. uv add sphinx-autobuild