Repository navigation
docs: add guided Mini-apps docs and wallet-config registration - #381
BrianSeong99 wants to merge 10 commits into
Conversation
|
For the game mini-apps, I think we should have one separate website, let’s call it Miden Arcade, where people find the games and shared rankings. Bread would list that website, and developers would ask us to add their game to the Arcade. Adding each game would happen through that project, without needing a separate listing PR for Bread. Could we reflect that in the publishing section? We should still have a guide for building mini-apps, and potentially a game-specific guide covering the record-note / shot-note convention once it’s reviewed. Also, who’s taking on the Arcade website itself? We kinda discussed the website @BrianSeong99 but I don’t think we settled that question. |
1 similar comment
|
For the game mini-apps, I think we should have one separate website, let’s call it Miden Arcade, where people find the games and shared rankings. Bread would list that website, and developers would ask us to add their game to the Arcade. Adding each game would happen through that project, without needing a separate listing PR for Bread. Could we reflect that in the publishing section? We should still have a guide for building mini-apps, and potentially a game-specific guide covering the record-note / shot-note convention once it’s reviewed. Also, who’s taking on the Arcade website itself? We kinda discussed the website @BrianSeong99 but I don’t think we settled that question. |
Give Bread mini-app developers a guided path from a compatible project to a working wallet integration and a reviewed Explore listing.
Add nine pages in current docs and v0.17: overview, setup, app design, Bread integration, Arcade, Finance, Others, testing and registration. The section uses the existing Miden documentation layout, Card/CardGrid, numbered Steps, callouts and typography. Add matching navigation icons, a Mini-apps sidebar icon and three sidebar groups: Start building, App guides, Test and ship. Card destinations follow the selected docs version.
The content leads with useful tasks and executable steps. Setup starts with a recursive clone of agentic-template, preserves its pins and explains the older frontend submodule versus the wallet-managed starter. Integration covers provider detection, explicit permissions, result reconciliation and optional native fullscreen. Longer code and implementation details are expandable; mobile lifecycle states use a readable table.
Registration follows the contract in wallet-config #10 and wallet #1512:
explore/<network>.json, directfinance/arcade/otherscategories, aggregate-only All, icons/sections, higher versions and concrete Node 22 validation commands. Legacy conversion is confined to persisted caches. Config publication must precede the matching reader release; older supported wallets retain wallet-explore.Games keep their own scoring. Shared GC balance ranking, authenticity/submission services, challenge contracts and rewards remain separate integrations. Financial apps document assets, fees, routes, settlement and recovery. Catalog visibility never grants wallet authority or establishes app/device acceptance.
Validation:
The branch includes current main's documentation baseline. Local preview services, browser runtime, screenshots and build evidence remain outside the checkout. No wallet transaction, public deployment or GitHub merge is performed.