Skip to content

docs: add guided Mini-apps docs and wallet-config registration - #381

Open
BrianSeong99 wants to merge 10 commits into
mainfrom
brian/docs-mini-app-v017
Open

BrianSeong99 wants to merge 10 commits into
mainfrom
brian/docs-mini-app-v017

Conversation

@BrianSeong99

@BrianSeong99 BrianSeong99 commented Oct 12, 2026 •

Copy link
Copy Markdown
Contributor

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, direct finance/arcade/others categories, 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:

  • TypeScript and all 49 existing Agentic/preparation checks pass.
  • Full optimized production build passes with no broken-link or anchor warnings. Local build uses Node 24.18.0, a 16 GiB heap and SSR concurrency 2; deployment already has its own larger-heap setting.
  • All nine authored pages match v0.17.
  • Isolated Chromium passes 35 route/viewport checks across current/stable docs, 360/390/768/1024/1440 widths and light/dark themes.
  • Seven overview cards/icons, sidebar icon, aligned category headings, actual card navigation, all guide-card destinations staying in the selected version, expandable code and local resource responses pass; zero page errors.
  • Desktop/mobile screenshots inspected. The documented registration item passes the actual config parser; whitespace checks pass.

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.

@BrianSeong99 BrianSeong99 changed the title docs: add Bread mini-app integration guidance for v0.17 docs: add a complete Mini-apps Solutions section for v0.17 Oct 12, 2026
@BrianSeong99
BrianSeong99 marked this pull request as ready for review October 12, 2026 07:47
@guelowrd

Copy link
Copy Markdown
Contributor

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
@guelowrd

Copy link
Copy Markdown
Contributor

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.

@BrianSeong99 BrianSeong99 changed the title docs: add a complete Mini-apps Solutions section for v0.17 docs: add Mini-apps guidance for native Explore and wallet-config registration Oct 14, 2026
@BrianSeong99 BrianSeong99 changed the title docs: add Mini-apps guidance for native Explore and wallet-config registration docs: add Mini-apps guides and wallet-config registration workflow Oct 17, 2026
@BrianSeong99 BrianSeong99 changed the title docs: add Mini-apps guides and wallet-config registration workflow docs: add guided Mini-apps docs and wallet-config registration Oct 17, 2026
@BrianSeong99
BrianSeong99 requested a review from guelowrd October 17, 2026 04:36
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.

2 participants