hasura / hasura/graphql-engine

Docs: Model reference documentation should talk about "why / what is a model"

Open
#10,329 1 comment 0 reactions 0 assignees View on GitHub
c/docs ddnbugbounty-2024 k/dx
Dominant language
TypeScript
Stars
32.1k
Forks
3k
PR merge metrics
PR metrics pending

Description

On the model documentation https://hasura.io/docs/3.0/supergraph-modeling/models shouldn't we mention why we add models?

For example:

Models create a standard API with a, b, c features and compose well with each other. here's an example of a model actually shows up in your API.

And then we go into the reference documentation?

Contributor guide

Open the contributing guide

Research direction

Start with the model documentation page at https://hasura.io/docs/3.0/supergraph-modeling/models and review its existing reference structure. Done means adding a clear explanation of why models are used, describing how they compose and appear in the API, and including a representative example before the reference material.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.