neo4j / docs-graphql

GraphQL docs
5 stars 9 forks source link

Review of type definitions, directives and schema configuration sections #22

Closed lidiazuin closed 1 year ago

neo-technology-commit-status-publisher commented 1 year ago

Thanks for the documentation updates.

The preview documentation has now been torn down - reopening this PR will republish it.

darrellwarde commented 1 year ago

I've directly committed some suggestions here, figured it was easier to do that and revert if we don't like it rather than try to make a long comment describing my proposals!

We discussed putting all of the types and directives under a single "Type definitions" section, so I've tried that, with an index page also for types like you did with directives (love the table!).

I moved "Pagination" under "Queries and aggregations", we also discussed this change together.

As I say, we can revert this! Was meant to be one commit but ended up as 4 because I broke so many references! 🤦

What do you think? 🙂

lidiazuin commented 1 year ago

I've directly committed some suggestions here, figured it was easier to do that and revert if we don't like it rather than try to make a long comment describing my proposals!

We discussed putting all of the types and directives under a single "Type definitions" section, so I've tried that, with an index page also for types like you did with directives (love the table!).

I moved "Pagination" under "Queries and aggregations", we also discussed this change together.

As I say, we can revert this! Was meant to be one commit but ended up as 4 because I broke so many references! 🤦

What do you think? 🙂

I think it's great! I wasn't sure about moving these pages to a higher level in the toc, so thank you for making the suggestion and the changes. :)) If there's nothing else, should we merge this one?