Skip to content

Discontinue rebundling commons reference documentation in implementation projects #2489

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

Open
xenoterracide opened this issue Oct 25, 2021 · 1 comment
Labels
type: documentation A documentation update

Comments

@xenoterracide
Copy link

I hate this, I kind of get why it's done but what's happening is confusion of what's actually supported in these projects, has a lot of this documentation says it's dependent on the implementation. Then the implementation doesn't actually mention what supported. I think it would be better to have some way that their documentation can either bundle only the parts they support or link back to only the parts they support.

For example I raised the question, And have asked for further documentation in neo4j of whether the Geo types are actually supported. I really couldn't tell from the reference documentation. Source diving shouldn't be required. Back in the day I had similar problem with neo4j and support for Optional. It could have course be argued that some of this is simply a problem with spring data in neo4j, I'm not sure, but I could see how it would easily be ignored to document that stuff since it's bundled in a sense.

@mp911de
Copy link
Member

mp911de commented Oct 26, 2021

Thanks for bringing this up. The documentation approach stems from a time where we had few store modules with a more or less consistent feature set. We plan to revise our documentation arrangement across the Spring portfolio and will consider how to improve the individual store module documentation with that endeavor.

@mp911de mp911de removed the status: waiting-for-triage An issue we've not yet triaged label Oct 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation update
Projects
None yet
Development

No branches or pull requests

3 participants