documentationjs / documentationjs/documentation

Predictable Doc Output Format for GraphQL

Open
#1,094 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
5.8k
Forks
481
PR merge metrics
No merged PRs in 30d

Description

This is more a feature request/future planning idea. Right now, the JSON output of a doc parsing run cannot (easily) be used with something like GraphQL because it requires a certain amount of predictability for querying. Because of the deeply nested nature of, for example, `description` elements, you can't produce a proper query against them. This same problem can apply against parameter types.

I'm not certain how to go about generating consistent and predictable output, but it seemed with the rise in popularity of GraphQL it was worth bringing up the issue to see if there were solutions (either from the documentation end or from the GraphQL end).

Does anyone have any thoughts on this?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.