Wolfgang WaltherandWolfgang Walther
3d95c41115
The obviously wrong statement is, that PostgREST does not support asymmetric keys, while it does. Extending on this type of attack is not necessary, because it is in fact covered by the paragraph before - reading the algorithm from the JWT header is the problem in that case, too. We don't do that. This leaves us with the sentence about how the chosen library is the most important part. While that is correct, the hint about high quality libraries for use on the *client* side is mis- leading: The important part here is the library we choose to implement PostgREST with, not the client-side lib. Thus, removing the whole paragraph is the best thing to do here. Resolves https://github.com/PostgREST/postgrest-docs/issues/123
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.