neo4j / docs-graphql

GraphQL docs
5 stars 9 forks source link

Tackling user feedback #35

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

@lidiazuin, I think merging these changes to the OGM reference will render the page quite inconsistent. If you go to the preview, you'll see that the table of argument for update now has three columns, but the other four operations still just have a two column table. We should probably be considering making it consistent across the board.

lidiazuin commented 1 year ago

@lidiazuin, I think merging these changes to the OGM reference will render the page quite inconsistent. If you go to the preview, you'll see that the table of argument for update now has three columns, but the other four operations still just have a two column table. We should probably be considering making it consistent across the board.

I agree. But then would you rather add examples to all cases or keep them the way they are?

darrellwarde commented 1 year ago

That's a lot of examples to add. 😅 In the long term, I would like to get rid of this API reference page entirely, and switch to more tutorial/how-to style. With that in mind, would it be worth the effort now?

lidiazuin commented 1 year ago

Not really, no. So I will revert that part!