TsDocs from the SDK #10
Conversation
Deploying with
|
| Latest commit: |
0d51778
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://1c291273.balancer-docs.pages.dev |
| Branch Preview URL: | https://tsdocs-sdk.balancer-docs.pages.dev |
|
Modules preview: https://tsdocs-sdk.balancer-docs.pages.dev/api/modules.html |
gmbronco
force-pushed
the
tsdocs-sdk
branch
2 times, most recently
from
ee299fa
to
a7dff02
Compare
|
I think I got our docs from comments to the point where we can replace existing SDK section with auto-generated docs. What do you think about it? For auto-generation I added vuepress-typedoc plugin which gives the best results compared to api-extractor. So far it's a manual task, but can be automated once we get comfortable with the content. It's a start, next steps I'm thinking about changing few things in the swaps module to make naming and flow consistent with joins/exists. |
|
Cool, I'll take a look through tomorrow |
|
Overall, I find it really hard to cut through the noise of the auto-generated docs to find informative details on how the SDK works. The existing SDK section has a high level page which introduces the reader to a topic, walks through, and provides tips, gotchas, and other details. Ex: a page like https://tsdocs-sdk.balancer-docs.pages.dev/sdk/reference/interfaces/Pool.html or https://tsdocs-sdk.balancer-docs.pages.dev/sdk/reference/enums/BalancerErrorCode.html I think are relatively pointless. I would remove the Enums, Interfaces, and Modules sections entirely. The Classes section can be useful, but should have more explanations about what each class is and how it can be used. Also, the full list of parameters can be greatly condensed by removing |
|
I'm with you. Classes section is very helpful in getting a quick insight what's there, but besides that it's too noisy. I really like how viem docs look like. Seems like they just maintain them manually. I'll look into making it more readable. |
* WIP * tabs structure * tempale ui complete * calendar-lockTime componenst * install web3modal + basic implementation * move stuff into Wallet component * wip * VeSystem Overview (data fetching) (#5) * Add LaunchpadSubgraph class * fetch launchpad data from subgraph * update UI with data * change UI max-lock time (#3) * change UI max-lock time * Changed max lock time calculation --------- Co-authored-by: Pablo F. Mescher <[email protected]> * wip * create Admin Panel + default tabs * launchpad hooks: deploy, refactor deploy form * submit button indicator * List token names (#7) * Admin Panel - Rewards Distribution / Admin Pools (#8) * RewardsDistribution Tab * Admin Pools (no design) * Basic Tab Navigation * Available rewards modal placeholder (#9) * Replace lauchpadProvider by VeSystemProvider (#10) * Admin Pools (#11) * Set Multiple Available Rewards (#12) Co-authored-by: Luigi <[email protected]> * VeSystem Config Fields (#13) * Ve System Config Fields and Buttons (#14) * Ve system config unlock all (#15) * Ve System Config - Early Unlock (#16) * Fixed Modals UI (#17) * Set Early Penalty Speed & fix styles (#18) * Added search by bptToken address functionality (#19) Co-authored-by: Luigi <[email protected]> Co-authored-by: esis8 <[email protected]> * Non admin flow pool details / lock (#20) * Tab Navigation * Pool Details Button * Lock Action * Approve Action * Pool Details Tab Data * Non Admin Flow - Withdraw (#21) * Adapt UI to work with new subgraph schema (#23) * Claim Modal (#22) * Update launchpad contract address (#24) * Available Rewards Modal (#25) * Properly formatting numbers (#26) * Admin Pools: Search by vested token address (#27) * Add Supply Vested % (#28) * fixed size buttons (#29) * Fix Calendar timestamp for adding rewards exact week (#30) * Network support first round (#33) * Add Polygon zkEVM * add config file * fixed design btn selector (#32) * Add contract addresses (#34) * add contract addresses * add subgraph urls * Missing Non Admin Feautures (#31) * EarlyWithdraw * increase_amount * increase_unlock_time * Increase Lock Detalis Modals (#35) * Add to early penalty * change texts * rename search placeholder * add activation functionality checkboxes (#36) * launchpad start-time fix * change texts * allow increase unlock * update contract address and abi * Claim External Rewards * catch error * fix lock timestamp issue * change title for user section * max lock time changes * Only Mumbai * add ethereum to fix issue * fix timezone issue (#37) * Network Support (#38) * networks: polygon, arbitrum, mumbai * Scope veSystems by admin (#40) * list veSystems by admin * fix switch network * remove code redundancy * Tooltips (#39) * Network support (#44) Add support for: * mainnet * optimisim * avalanche * base * gnosis Update contract addresses * Replace mumbai with sepolia (#45) * Added detailed documentation (#52) * Documentation added * Detailed docs and changes to launchpad page * Update admin-ve8020.md --------- Co-authored-by: Pablo F. Mescher <[email protected]> Co-authored-by: esis8 <[email protected]> Co-authored-by: E Esis <[email protected]> Co-authored-by: Pablo F. Mescher <[email protected]> Co-authored-by: burns <[email protected]>
First step to sync code comments with the docs.
Not yet exposed in the navigation, accessible under /api (temporary default name).
Good to have them browsable, easier to see what we need to do to clean them up.
Starting with BalancerSDK class, our main entry point, which doesn't have any comments or examples.