-
Notifications
You must be signed in to change notification settings - Fork 48
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
Adding Groups and Categories to Organize SDK #546
base: main
Are you sure you want to change the base?
Conversation
Now that we've merged in the main docs revisions, this is a follow up to add the folder structure to the typedoc :) We split these into separate PRs since this one is conceptually very simple (just add @category and @group tags into the proper folder structure) - so didn't want to further clutter things in the other (already massive) PR. For context, @category = big folder and @group = small folder. @gregnazario Would it be better for us to merge this in, then generate the docs later - or to include generated docs as part of this PR? |
Let's get this in now, (I merged in another one your PRs that might have conflicted) |
Ok, I'll fix the merge conflicts here tomorrow |
Description
This PR will organize the types, enums, functions, variables, classes into either Client (classes which the client calls to use Aptos resources) and Implementation (The details of the internals of said resources), there is also a "Modules->PrivateCode" that provides the internal resources which are not client-facing. Those are available and viewable so the @mixin tagging functions properly.
This will neatly organize the UI to look like the attached images.
Here, you can see the implementation organization for providing users the context of the provided resources.
Here, you can see the neat stacking of Client, Implementation, and Module folders.
Here, you can see the organization of the methods callable via "Aptos" - organized so that the user can select here or in the sidebar.
Test Plan
Extensive manual review
Automatic linting
Related Links
Checklist
pnpm fmt
?