Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Does graphql-docs have a way to merge pages by type kind? #142

Open
ind1go opened this issue Nov 24, 2023 · 1 comment
Open

Does graphql-docs have a way to merge pages by type kind? #142

ind1go opened this issue Nov 24, 2023 · 1 comment

Comments

@ind1go
Copy link
Contributor

ind1go commented Nov 24, 2023

Is your feature request related to a problem? Please describe.
I'm trying to make a large schema make sense without having the information spread across hundreds of different pages.

Describe the solution you'd like
I'd be interested in a solution which took the content that would normally end up in the per-type kind index (say for scalars, that would be scalar/index.html) and each of the type kind's types (so for scalars that would be scalar/boolean/index.html, scalar/float/index.html, ...) and merged them into a single page. The solution would be similar in appearance to GitHub's GraphQL doc.

Describe alternatives you've considered
This may already be possible, I just can't find an option for it!

@brettchalupa
Copy link
Owner

@ind1go thanks for opening the issue! Your best bet would be to explore customizing the layout files in https://github.com/brettchalupa/graphql-docs/tree/main/lib/graphql-docs/layouts, which can be configured to be overridden (see the README). Forking the gem and customizing further to your needs might also work. Unfortunately, the core flow of the gem is that each scalar, enum, query, etc. has its own URL and that assumption drives the templates and code. So you might run into some limitations with the layout file customizations.

If you're needing some more help here, let me know and I can do some further exploring into either 1. supporting this or 2. how to customize the code to support it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants