hasura/graphql-engine
1
0
Fork 0
mirror of https://github.com/hasura/graphql-engine.git synced 2024-12-14 17:02:49 +03:00
Code Issues Projects Releases Wiki Activity
a2e6e50e27
graphql-engine/server/documentation
History
hasura-bot a2e6e50e27 Fix broken links 
GITHUB_PR_NUMBER: 9138
GITHUB_PR_URL: https://github.com/hasura/graphql-engine/pull/9138

PR-URL: https://github.com/hasura/graphql-engine-mono/pull/6462
Co-authored-by: arpitpandey0209 <9442768+arpitpandey0209@users.noreply.github.com>
GitOrigin-RevId: 85ce1a190477803f553deb31c1c95b512fa3fca0
2022-10-26 14:22:19 +00:00
..
data-sources server/tests: unify HASURA_BIGQUERY_SERVICE_KEY and HASURA_BIGQUERY_SERVICE_ACCOUNT env vars 2022-03-14 07:50:35 +00:00
deep-dives [documentation] add more details to remote joins engineering documentation 2022-10-24 20:54:26 +00:00
glossary.md Structural updates to the server's engineering documentation 2022-05-30 09:46:06 +00:00
overview.md Fix broken links 2022-10-26 14:22:19 +00:00
README.md [gh-pages] Remove broken haddock links from hasura.github.io 2022-05-30 12:22:49 +00:00
tips.md server/postgres: test identifier uniqueness rewrite 2022-06-17 10:44:18 +00:00

README.md

Server engineering documentation

This page documents the structure and the internal architecture of the GraphQL Engine Server. To get started, you can read the overview. We also maintain a glossary of all the terms we use throughout the code and the documentation.

You can also get started with a list of tips and tricks.

Haddock documentation

You can browse the engine's haddock documentation for the stable branch, main branch, and every previous version release since v2.2.0.

Architecture deep-dive

Backend-specific documentation

Notes

In our Haskell codebase, we use GHC-style notes for long-form comments detailing a specific aspect of the codebase. We gather all of them, as of the main branch, in the notes subfolder.

Updating this documentation

All markdown files in this folder are either copied verbatim from server/documentation or generated as part of our CI; do not open a PR to modify files in the gh-pages branch, and instead modify their source directly. Notes are extracted using the scripts/extract-nodes bash script. The haddock documentation is generated by running cabal haddock --haddock-internal --haddock-options="--ignore-all-exports".