hasura/graphql-engine
1
0
Fork 0
mirror of https://github.com/hasura/graphql-engine.git synced 2024-12-16 01:44:03 +03:00
Code Issues Projects Releases Wiki Activity
8510cbfe87
graphql-engine/server/documentation
History
Tom Harding 59df4dffb3 [gh-pages] Remove broken haddock links from hasura.github.io 
Hello!

I noticed that on [the deployed docs](https://hasura.github.io/graphql-engine/server/), [the first Haddock link](https://hasura.github.io/graphql-engine/server/haddock) and alpha/beta links were broken. I've removed the broken links and checked the other two.

Thanks!

PR-URL: https://github.com/hasura/graphql-engine-mono/pull/4536
GitOrigin-RevId: 52d575996c01c2ebf2396987b39474013c93812d
2022-05-30 12:22:49 +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 Structural updates to the server's engineering documentation 2022-05-30 09:46:06 +00:00
glossary.md Structural updates to the server's engineering documentation 2022-05-30 09:46:06 +00:00
overview.md Structural updates to the server's engineering documentation 2022-05-30 09:46:06 +00:00
README.md [gh-pages] Remove broken haddock links from hasura.github.io 2022-05-30 12:22:49 +00:00
tips.md Structural updates to the server's engineering documentation 2022-05-30 09:46:06 +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".