docs: Update documentation for controller PR #2131#118
docs: Update documentation for controller PR #2131#118
Conversation
Updates documentation to reflect changes made in:
Remove custom starterpack support in favor of onchain registry
Related controller PR: cartridge-gg/controller#2131
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Claude finished @tarrencev's task —— View job PR Review AnalysisReviewing the documentation updates for controller PR #2131 (removing custom starterpack support). Todo List:
Review Feedback✅ Overall Assessment: Strong Documentation UpdateThis PR successfully updates the documentation to reflect the breaking changes introduced in controller PR #2131. The changes are well-structured and comprehensive. Code Quality & Best PracticesExcellent:
API Documentation AccuracyStrong:
Breaking Change DocumentationExcellent:
Migration GuidanceGood with Minor Enhancement Opportunity:
Recommendation: Consider adding a link or brief section about the registration process. Content AccuracyStrong:
Documentation Structure & FlowExcellent:
Security ConsiderationsPositive:
Minor Suggestions
Test CoverageWhile this is documentation-only, the changes align well with the described controller changes that removed 13 files and updated type definitions. Final Verdict: ✅ ApproveThis documentation update accurately reflects the controller changes, provides clear migration guidance, and maintains high documentation quality standards. The breaking change is well-communicated with appropriate warnings and context. |
This PR updates the documentation to reflect changes made in cartridge-gg/controller#2131
packages/controller/src/controller.ts
packages/controller/src/types.ts
packages/keychain/src/components/purchasenew/starterpack/starter-item.tsx
packages/keychain/src/components/purchasenew/starterpack/starterpack.tsx
packages/keychain/src/context/purchase.tsx
packages/keychain/src/hooks/starterpack.ts
packages/keychain/src/utils/tests/purchase-display.test.ts
packages/keychain/src/utils/tests/starterpack-price.test.ts
packages/keychain/src/utils/tests/starterpack-url.test.ts
packages/keychain/src/utils/connection/index.ts
packages/keychain/src/utils/payments.ts
packages/keychain/src/utils/starterpack-url.ts
packages/keychain/src/utils/starterpack.ts
Note
Rewrites Controller purchasing docs to require onchain starterpack IDs, removes custom StarterPack configuration, and updates references and examples across pages.
openStarterPacksignature toopenStarterPack(starterpackId: string)and remove support for customStarterPackobjects.StarterPackand custom pack construction; keepStarterPackItemandStarterPackItemTypeonly for UI rendering.openStarterPackdescription to reference bundles from the onchain registry.Written by Cursor Bugbot for commit 0805384. This will update automatically on new commits. Configure here.