-
Notifications
You must be signed in to change notification settings - Fork 147
refactor(docs): split monolithic api reference into multiple files #722
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
refactor(docs): split monolithic api reference into multiple files #722
Conversation
|
@Victorsitou re: #722 (review)
Since this doesn't affect the output, it's mostly personal choice - i'd go with the second one. Either way, this isn't worth updating manually, so unless we introduce an .rst formatter, we should leave it as is.
Updated in 627c038. Lines 764 to 765 in 48c99b7
|
|
@onerandomusername re: #722 (comment)
Old comment, but I've moved
Keeping |
👍
👍 |
- InstallParams is a Discord Model - Raw* events are Discord Models - SessionStartLimit is a Discord Model - GuildBuilder is a Data Class - BanEntry is a Discord Model - Localized is a regular class - AsyncIterator is a regular class
shiftinv
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.
Alrighty.
At this point, I've probably gone over all the changes several times, including comparing the old/new rst side-by-side today and updating anything that was missed.
Certainly took us a while, but I believe it's finally at a point where I'm comfortable merging it without second thoughts - it's not that it wasn't good before, but since documentation is a very core part of everything here, I prefer to quadruple-check that everything is in order :>
This has been a pretty monumental task, and I really appreciate @ItsAleph taking the initiative by creating this PR more than half a year ago and also implementing by far the biggest part of this whole endeavor.
It turned into more of a community project over time, with @onerandomusername (and me) updating parts of it and @Victorsitou and @Chromosomologist reviewing changes (thanks c:), but after 237 comments so far it's gotten to a point where anything that was potentially missed can be taken care of in another PR.
tl;dr: ![]()
Victorsitou
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.
thank you very much to everyone who has contributed :)
|
Thanks much to everyone! This wouldn't have been possible without your help! |
onerandomusername
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.
looks good. Any bugs that we find from this point onwards can be fixed in a separate pull request.
Summary
This PR splits up the documentation into multiple files.
Fixes #392
Most pages now load in < 1s, instead of previous 20s.
Some info
Before The Split Up Thing
Clean build time (
cd docs && time make html)After The Split Up Thing
Clean build time (
cd docs && time make html)Largest files and their size
Before The Split Up Thing (
find . -type f -printf '%s %p\n'|sort -nr|head -n 3)After The Split Up Thing (
find . -type f -printf '%s %p\n'|sort -nr|head -n 10)Checklist
task linttask pyright