-
-
Notifications
You must be signed in to change notification settings - Fork 791
Rearrange / rename API reference docs #4022
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
base: main
Are you sure you want to change the base?
Conversation
|
I will take a look this evening. |
kattni
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I somehow failed to click "Finish" in this. I didn't notice until I noticed that my email didn't have a new reply for this PR. 🤦🏻♀️
I have one suggestion below. Otherwise, we discussed everything else.
Co-authored-by: Kattni <[email protected]>
|
@kattni @freakboy3742 I think I've covered everything we talked about the other week:
|
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: