RFC: Adding a glossary to the GraphQL Specification#846
RFC: Adding a glossary to the GraphQL Specification#846leebyron merged 1 commit intographql:mainfrom
Conversation
👍 |
|
Ideally these terms are defined when introduced in the context in which they're most relevant, and the glossary could then be derived from these terms. It would also be really nice to have glossary terms linked in the rendered result. How do you feel about adding term definition and automatic glossary generation to spec-md? |
leebyron
added
the
📣 RFC document
|
Merging since this is a RFC doc. I'm in strong support of having better term definition |
|
I’d definitely be up for chatting with you about how the spec-md changes might work and then potentially implementing them but I don’t currently know what changes would make sense so I think it warrants discussion. Automated > manual 👍 |
3 participants
Since #777 is near to merging, it's time to extract the glossary work into a separate PR.
At this stage, the glossary is incomplete; I suggest that we merge this as an RFC as-is, iterate on it with follow-up PRs (fixing existing text and adding new definitions) and then when it's ready we can propose to the GraphQL Working Group that it gets merged into the specification.
You can read more about the intent of this PR in the included
rfcs/glossary/README.mdfile.Relates to GraphQL Spec Working Group action item graphql/graphql-wg#547.