Skip to content

docs: Update documentation for controller PR #2131#118

Closed
tarrencev wants to merge 1 commit intomainfrom
docs-update-1761086515
Closed

docs: Update documentation for controller PR #2131#118
tarrencev wants to merge 1 commit intomainfrom
docs-update-1761086515

Conversation

@tarrencev
Copy link
Contributor

@tarrencev tarrencev commented Oct 21, 2025

This PR updates the documentation to reflect changes made in cartridge-gg/controller#2131

**Original PR Details:**
- Title: Remove custom starterpack support in favor of onchain registry
- Files changed: examples/next/src/components/Starterpack.tsx

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

Please review the documentation changes to ensure they accurately reflect the controller updates.

Note

Rewrites Controller purchasing docs to require onchain starterpack IDs, removes custom StarterPack configuration, and updates references and examples across pages.

  • Purchasing / API:
    • Change openStarterPack signature to openStarterPack(starterpackId: string) and remove support for custom StarterPack objects.
    • Delete examples/imports using StarterPack and custom pack construction; keep StarterPackItem and StarterPackItemType only for UI rendering.
    • Add Onchain Starterpack Registry section with breaking-change notice and migration guidance.
  • Configuration:
    • Update openStarterPack description to reference bundles from the onchain registry.
  • Overview:
    • Replace monetization bullet with emphasis on an onchain starterpack registry for immutable bundles.

Written by Cursor Bugbot for commit 0805384. This will update automatically on new commits. Configure here.

    Updates documentation to reflect changes made in:
    Remove custom starterpack support in favor of onchain registry

    Related controller PR: cartridge-gg/controller#2131
@vercel
Copy link

vercel bot commented Oct 21, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Updated (UTC)
docs Ready Ready Preview Oct 21, 2025 10:42pm

@claude
Copy link
Contributor

claude bot commented Oct 21, 2025

Claude finished @tarrencev's task —— View job


PR Review Analysis

Reviewing the documentation updates for controller PR #2131 (removing custom starterpack support).

Todo List:

  • Read and analyze configuration.md changes
  • Read and analyze overview.md changes
  • Read and analyze purchasing.md changes (main file)
  • Check API documentation accuracy
  • Verify breaking change documentation
  • Review migration guidance
  • Provide comprehensive feedback

Review Feedback

Overall Assessment: Strong Documentation Update

This 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 Practices

Excellent:

  • Clear, consistent documentation structure across all files
  • Proper use of TypeScript code examples with correct syntax
  • Well-organized content with logical flow and appropriate headings
  • Good use of warning boxes and breaking change notices

API Documentation Accuracy

Strong:

  • openStarterPack(starterpackId: string) signature is correctly updated in configuration.md:172
  • Method descriptions accurately reflect the new onchain registry requirement
  • TypeScript interfaces (StarterPackItem, StarterPackItemType) are properly documented for UI rendering purposes
  • Import statements are updated to remove deprecated custom StarterPack references

Breaking Change Documentation

Excellent:

  • Clear warning box in purchasing.md:101-105 highlighting the breaking change
  • Explicit version information (Controller v2.0) specified
  • Migration guidance provided with actionable steps
  • Context about why the change was made (onchain metadata, immutability, security)

Migration Guidance

Good with Minor Enhancement Opportunity:

  • The documentation explains what developers need to do (register starterpacks in Arcade Registry)
  • However, it could benefit from more specific guidance on how to register starterpacks in the Arcade Registry Contract

Recommendation: Consider adding a link or brief section about the registration process.

Content Accuracy

Strong:

  • Overview change (overview.md:47) correctly emphasizes "onchain starterpack registry for secure, immutable bundles"
  • Technical details about Merkle Drop claims, cross-chain support, and fee structures remain accurate
  • Removed references to custom StarterPack objects throughout

Documentation Structure & Flow

Excellent:

  • Logical progression from Quick Start → API Reference → Breaking Changes → Implementation Details
  • Good balance of high-level concepts and technical specifics
  • Clear separation between what's deprecated vs. what remains available

Security Considerations

Positive:

  • The move to an onchain registry improves security posture
  • Documentation properly emphasizes the immutability and validation benefits
  • No security concerns identified in the documentation changes

Minor Suggestions

  1. Line 104 in purchasing.md: Consider adding a link to documentation about the Arcade Registry Contract registration process
  2. Consistency: All three files properly reflect the changes - good consistency across the documentation

Test Coverage

While this is documentation-only, the changes align well with the described controller changes that removed 13 files and updated type definitions.


Final Verdict: ✅ Approve

This 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.


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant