Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Documentation: Generate Docs for the data module #7264
This PR adds docs generation for the data module's selectors/actions.
It doesn't integrate with the Handbook yet but it should be possible to add a step to call this command line before doing the synchronization cc @pento
Its output is markdown to ease integration into other docs systems like the handbook.
The docs can be gitignored at some point but I think it's fine to do the generation manually as a start.
I think this is great and there's some helpful stuff in here, but we should work to improve the signal-to-noise ratio of the docs and assume a lot less knowledge in them.
There are a lot of functions here whose name/name+parameters explain everything (or where if they don't, the docs are just re-stated function signatures.
I made some suggestions on particular docs but they apply throughout, really. If my suggestions make sense and can be extrapolated to the rest of the docs I'm happy to review again after a pass with my thoughts in mind.
If I need to clarify my general thoughts more/my criticisms are unclear just let me know
This is an awesome effort and will be really handy for new devs when iterated upon.
Thanks for the review @tofumatt Great feedback here.
I'd like to keep this PR focused on the docs generation aspect and not the descriptions/docs them selves. I'd like to tackle those comments in a separate PR (Probably worth creating an issue with a link to these comments).
The extra new lines is probably something related to the docs generation tool itself though.
So my bad, I didn't realise this was all generated; I should have realised with such a massive green line count
Thanks for filing the issue related to the content of the documentation itself; for now my issues with this PR are just with nitpicks around the newlines and such
r+wc (That's Mozilla-speak for approved-once-comments-are-addressed)
Code looks good and the generated documentation looks a bit cleaner too
By the way, @atimmer, your review is warmly welcomed :)