Contributing

Sphinx files are written in the RST markup language. Here is a guide to RST markup language.

Requirements

Fork the repo and clone it:

git clone https://github.com/<your-username>/graphql-engine

Move to docs folder and checkout to a new branch:
```
cd docs
git checkout -b <new-branch-name>
```
Install dependencies (Sphinx, beautifulsoup4, algoliasearch, etc.)
```
pip3 install -r requirements.txt
```
For development, live reload and auto build while you're editing and saving files:
```
make livehtml
```
Make the required changes.
(Optional) Build docs to produce HTML files and verify:
```
ENV=<development|production> make html-images
```
- The generated docs are in _build/html.
- View the built files by running a webserver. egg:
```
cd _build/html && http-server
```
  or
```
cd _build/html && python3 -m http.server 8080
```
Commit the changes. Follow common guidelines for commit messages at main contributing guide.
Push the changes to your fork and submit a pull request.

Note: The search is powered by Algolia and is updated on every deployment. Your local changes will not reflect in search results.