ab8ccf43a6
* add domain representations * Update docs/references/api/domain_representations.rst Co-authored-by: Alexander Ljungberg <aljungberg@wireload.net> * Update docs/references/api/domain_representations.rst Co-authored-by: Alexander Ljungberg <aljungberg@wireload.net> * Update docs/references/api/domain_representations.rst Co-authored-by: Alexander Ljungberg <aljungberg@wireload.net> * Update docs/references/api/domain_representations.rst Co-authored-by: Alexander Ljungberg <aljungberg@wireload.net> * Update docs/references/api/domain_representations.rst Co-authored-by: Alexander Ljungberg <aljungberg@wireload.net> * Update docs/references/api/domain_representations.rst Co-authored-by: Alexander Ljungberg <aljungberg@wireload.net> * add custom domain subheading and TOC this way it can be seen at the beggining there are advantages over views and computed fields. * important note for scache reloading * clarify advantages * why not create a type? --------- Co-authored-by: Alexander Ljungberg <aljungberg@wireload.net>
PostgREST documentation https://postgrest.org/
PostgREST docs use the reStructuredText format, check this cheatsheet to get acquainted with it.
To build the docs locally, use nix:
nix-shell
Once in the nix-shell you have the following commands available:
postgrest-docs-build: Build the docs.postgrest-docs-serve: Build the docs and start a livereload server onhttp://localhost:5500.postgrest-docs-spellcheck: Run aspell.
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.