Files
postgrest/docs
Wolfgang Walther 6d79090e4a docs: remove outdated "in production" links
Moat has been bought by Oracle. The advertising subpage redirects to
oracle.com, but pointing at that would be a bit misleading.

No need to keep failing links either.
2025-05-28 09:19:36 +02:00
..
2022-03-14 21:03:01 +01:00
2024-07-13 17:14:11 +02:00
2022-03-27 17:54:48 +02:00
2025-02-22 16:12:33 +01:00
2025-02-22 16:12:33 +01:00
2024-06-19 08:42:02 +02:00

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 on http://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.