-
Notifications
You must be signed in to change notification settings - Fork 153
Description
I need you to think deeply. We want to investigate the architecture of the SDK, of each of its packages, of each first level component module in its packages. Goal: extract the invariants of the code design or behavior at every level.
If the invariants are simple enough, you can express them in OCL; if more complex, you can express them in natural language; be careful and precise. Take your time, you do have time. Go in depth.
Investigate the codebase and also, clone yourself docs/ repo from the same org and see its SDK arch docs sections.
When you are done, review your work. Does it go in depth enough? If you can go deeper, replan and do it again for all levels.
Make a new branch on docs/ and add to the arch docs your work. It can be multiple docs, and/or it can be additions, sections added, to the existing docs, per component outlined there. You decide and make it consistent.
When you are done, open PR to docs, then check CI; wait a little to see if it passes and if it deploys. The deployment to mintlify will have a link for you to fetch and see the result. If you see errors on page, fix them - and verify deployment again.