steve-chavez
87dddd66d2
It's not immediately clear on which port the API server is listening. Also it's not clear that the "pgrst" channel is for database notifications. Goes from: <timestamp>: Admin server listening on 0.0.0.0:3001 <timestamp>: Listening on 0.0.0.0:3000 <timestamp>: Listening for notifications on the "pgrst" channel To: <timestamp>: Admin server listening on 0.0.0.0:3001 <timestamp>: API server listening on 0.0.0.0:3000 <timestamp>: Listening for database notifications on the "pgrst" channel
PostgREST documentation https://postgrest.org/
PostgREST docs use the reStructuredText format, check this cheatsheet to get acquainted with it.
To build the docs locally, see the Nix development readme.
Documentation structure
This documentation is structured according to tutorials-howtos-topics-references. For more details on the rationale of this structure, see https://www.divio.com/blog/documentation.
Translating
To create .po files for translation into a new language pass the language code as the first argument to postgrest-docs-build.
Example to add German/de:
postgrest-docs-build de
The livereload server also supports a language/locale argument to show the translated docs during translation:
postgrest-docs-serve de
Spellcheck is currently only available for the default language.