diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..20fdb43db --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,3 @@ +This repository follows the same contribution guidelines as the main PostgREST repository contribution guidelines: + +https://github.com/PostgREST/postgrest/blob/master/.github/CONTRIBUTING.md diff --git a/README.md b/README.md index f60577cdc..e8a06defb 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,11 @@ Or if you use [nix](https://nixos.org/nix/), you can just run: Both of these options will build the docs and start a livereload server on `http://localhost:5500`. +## 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. + ## Translations Translations are maintained in separate repositories forked from this one. Once you finish translating in your fork you can upload the project