Rearrange / rename API reference docs #4022
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #3941
Changes
I've checked the redirects by downloading the 0.5.3 sitemap and using the following script:
I also turned on traffic analytics on readthedocs, so I could see what's been getting 404 errors and add those too.
Remaining questions
Whether Document goes in Resources or Application Components.
Finalizing the shortened API descriptions, and/or keeping both a long and a short version.
Now that I've tried it out, I think sticking to one consistent (brief) description is still the way to go; it reads more like the top line of a docstring. This may necessitate reintroducing some of the removed detail at the beginning of the Usage section. I've waited to do this, or to spend much time going over and finalizing shortened versions, before getting feedback on whether the general approach looks good to others.
How (or if) to visually make the Container Widgets table be visually a subcategory of Widgets.
I've tried using a lower-level heading:
And even mucking about with a faux-header insert:
I don't think either of these look good or read as intended, and the latter exacerbates how tall the Widgets table already is, requiring even more scrolling up to find the header labels. (Unfortunately, sticky headers doesn't seem to be possible with mkdocs Materials.)
It's already structurally a subcategory, and reads as such in the sidebar nav. Perhaps that's enough?
PR Checklist: