READMEs · Open-source software
Hasura GraphQL Engine README
Hasura GraphQL Engine: a pinned README that routes readers through Hasura V3, Hasura V2.
Our interpretation
Useful when you are building…
Segment the product by major engine generation before repository setup.
Observed in the source
Patterns and sections
Hasura V3
The pinned README includes a distinct Hasura V3 route that helps readers choose a product or implementation path.
Hasura V2
The pinned README includes a distinct Hasura V2 route that helps readers choose a product or implementation path.
Cloning repository
The pinned README includes a distinct Cloning repository route that helps readers choose a product or implementation path.
Shallow clone
The pinned README includes a distinct Shallow clone route that helps readers choose a product or implementation path.
Support & Troubleshooting
The pinned README includes a distinct Support & Troubleshooting route that helps readers choose a product or implementation path.
Section labels refer to the reviewed public source. Visual design and mobile behavior of the external page were not evaluated.
Adaptation ideas
What to apply to your own product
- Provide a shallow clone and a V3-only checkout for developers who do not need the whole tree.
- Segment the product by major engine generation before repository setup.
Tradeoff to consider
Version choice and checkout depth are explicit tradeoffs for onboarding cost.
Starting route
Choose Hasura V3/V2, then use Cloning repository or the shallow/V3-only options.
Source and version
- graphql-engine/README.md at ed6ea94959706f23cbc21d12330ffb406a4e0e60 · hasura/graphql-engine · GitHub ↗https://github.com/hasura/graphql-engine/blob/ed6ea94959706f23cbc21d12330ffb406a4e0e60/README.md
Reviewed README at commit ed6ea94959706f23cbc21d12330ffb406a4e0e60. The linked file is pinned to that revision; the live repository may change.
Retrieved with Firecrawl. Content reviewed; product not installed or tested. Annotations are original editorial analysis.