steve-chavez
8271885bb2
As mentioned in https://github.com/PostgREST/postgrest-docs/issues/249, the embracing the relational model sectin would better fit in a page about our REST style. The shared improvements section no longer seems relevant since we're already an established open source project. Release notes are not removed but hidden from the index page.
PostgREST documentation http://postgrest.org/
PostgREST docs use the reStructuredText format, check this cheatsheet to get acquainted with it.
You can use pipenv to build the docs locally:
pipenv install
pipenv run python livereload_docs.py
Or if you use nix, you can just run:
nix-shell
Both of these options will build the docs and start a livereload server on http://localhost:5500.
Translations
Translations are maintained in separate repositories forked from this one. Once you finish translating in your fork you can upload the project to https://readthedocs.org and we'll link to it in the official documentation site https://postgrest.org.
See more details in the chinese translation PR.
Available translations
- Chinese - https://github.com/Lellansin/postgrest-docs (latest version
v0.4.2.0)