Skip to content

docs(website): add Use Cases section with Light Wallets, Bridges; add Case Studies section with Daedalus#3200

Merged
dalibran merged 25 commits into
mainfrom
docs/use-cases
May 29, 2026
Merged

docs(website): add Use Cases section with Light Wallets, Bridges; add Case Studies section with Daedalus#3200
dalibran merged 25 commits into
mainfrom
docs/use-cases

Conversation

@dalibran

Copy link
Copy Markdown
Collaborator

Summary

  • Adds a Use Cases dropdown to the navbar, positioned between Manual and Protocol
  • Renames navbar labels: "User manual" → "Manual", "About Mithril" → "Protocol"
  • Adds a Wallets use case page (/use-cases/wallets) covering two audiences:
    • Wallet developers: value prop, how Mithril fits existing stack, integration guide, Discord CTA
    • Wallet users: plain-language explanation of what Mithril-enabled wallets mean for them
  • Includes a caution admonition noting protocol security scales with SPO participation — the client is production-ready but full production wallet deployment should wait for sufficient stake coverage
  • Adds useCasesSideBar to sidebars.js and version-maintained-sidebars.json
  • Mirrors new docs into versioned_docs/version-maintained/ to support the version dropdown

Notes for reviewers

  • The caution admonition wording around stake participation thresholds is intentionally vague — flagging for technical review to sharpen the specific threshold language
  • The version dropdown label/ordering is a separate open question flagged for future discussion

Test plan

  • Verify Use Cases dropdown appears in navbar and links correctly
  • Verify Wallets page renders correctly in both current and maintained versions
  • Verify caution and note admonitions render correctly
  • Verify Discord button opens correct channel
  • Check right-side TOC shows correct heading hierarchy

🤖 Generated with Claude Code

@dalibran dalibran self-assigned this Apr 14, 2026
@github-actions

github-actions Bot commented Apr 14, 2026

Copy link
Copy Markdown

Test Results

     5 files  ± 0     206 suites  ±0   52m 29s ⏱️ - 3h 55m 36s
 3 058 tests  - 69   3 058 ✅  - 69  0 💤 ±0  0 ❌ ±0 
10 460 runs   - 78  10 460 ✅  - 78  0 💤 ±0  0 ❌ ±0 

Results for commit 4382f52. ± Comparison against base commit a45341d.

This pull request removes 69 tests.
mithril-stm ‑ circuits::halo2::tests::golden::cases::negative::slow::index_out_of_bounds
mithril-stm ‑ circuits::halo2::tests::golden::cases::negative::slow::index_too_large_for_circuit_range
mithril-stm ‑ circuits::halo2::tests::golden::cases::negative::slow::indices_not_increasing
mithril-stm ‑ circuits::halo2::tests::golden::cases::negative::slow::leaf_merkle_path_mismatch
mithril-stm ‑ circuits::halo2::tests::golden::cases::negative::slow::leaf_swap_keep_merkle_path
mithril-stm ‑ circuits::halo2::tests::golden::cases::negative::slow::leaf_wrong_verification_key
mithril-stm ‑ circuits::halo2::tests::golden::cases::negative::slow::merkle_path_corrupt_sibling
mithril-stm ‑ circuits::halo2::tests::golden::cases::negative::slow::merkle_path_flip_position
mithril-stm ‑ circuits::halo2::tests::golden::cases::negative::slow::merkle_path_length_long
mithril-stm ‑ circuits::halo2::tests::golden::cases::negative::slow::merkle_path_length_short
…

♻️ This comment has been updated with latest results.

@dalibran
dalibran temporarily deployed to testing-preview April 14, 2026 18:59 — with GitHub Actions Inactive
Comment thread docs/website/root/use-cases/wallets.mdx Outdated
Comment thread docs/website/root/use-cases/wallets.mdx Outdated
Comment thread docs/website/root/use-cases/wallets.mdx Outdated
Comment thread docs/website/root/use-cases/wallets.mdx Outdated
Comment thread docs/website/root/use-cases/wallets.mdx Outdated
Comment thread docs/website/root/use-cases/wallets.mdx Outdated
Comment thread docs/website/root/use-cases/wallets/light-wallets.mdx
Comment thread docs/website/root/use-cases/wallets.mdx Outdated
Comment thread docs/website/root/use-cases/wallets.mdx Outdated
Comment thread docs/website/root/use-cases/wallets.mdx Outdated
Comment thread docs/website/root/use-cases/wallets.mdx Outdated
Comment thread docs/website/root/use-cases/wallets.mdx Outdated
Comment thread docs/website/root/use-cases/wallets.mdx Outdated
Comment thread docs/website/root/use-cases/wallets.mdx Outdated
Comment thread docs/website/root/use-cases/wallets.mdx Outdated
Comment thread docs/website/root/use-cases/wallets.mdx Outdated
Comment thread docs/website/versioned_docs/version-maintained/use-cases/wallets.mdx Outdated
@dalibran dalibran linked an issue Apr 17, 2026 that may be closed by this pull request
@dalibran
dalibran temporarily deployed to testing-preview April 17, 2026 19:59 — with GitHub Actions Inactive
Comment thread docs/website/root/use-cases/wallets/light-wallets.mdx
@dalibran dalibran changed the title docs(website): add Use Cases section with Wallet integration guide docs(website): add Use Cases section with Light Wallets, Bridges; add Case Studies section with Daedalus May 13, 2026
Comment thread docs/website/root/use-cases/bridges.mdx Outdated
Comment thread docs/website/root/case-studies/daedalus.mdx
Comment thread docs/website/root/case-studies/daedalus.mdx Outdated
Comment thread docs/website/root/case-studies/daedalus.mdx Outdated
Comment thread docs/website/root/use-cases/bridges.mdx
Comment thread docs/website/root/use-cases/bridges.mdx Outdated
Comment thread docs/website/root/use-cases/bridges.mdx Outdated
Comment thread docs/website/root/use-cases/bridges.mdx Outdated
Comment thread docs/website/root/use-cases/bridges.mdx Outdated
Comment thread docs/website/root/use-cases/bridges.mdx Outdated

@jpraynaud jpraynaud left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

I left final comments to be addressed before merging.

Before merging, can you also:

  • Rebase the branch on main
  • Run the ./docs/devbook/bump-versions/bump_versions.sh --run --commit to bump the versions

Comment thread docs/website/root/use-cases/bridges.mdx Outdated
Comment thread docs/website/versioned_docs/version-maintained/case-studies/daedalus.mdx Outdated
Comment thread docs/website/src/css/custom.css Outdated
dalibran and others added 10 commits May 29, 2026 20:27
- Add Use Cases dropdown to navbar (between Manual and Protocol)
- Rename navbar labels: "User manual" → "Manual", "About Mithril" → "Protocol"
- Add Wallets use case page covering developer and end-user audiences
- Add useCasesSideBar to sidebars.js and versioned sidebars
- Wallet page includes: security caution admonition, integration guide,
  Discord CTA button, and note on server membership

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Wrap button text in a span to prevent MDX from injecting a paragraph
element with inherited margin-bottom, and use explicit height on the
anchor for reliable vertical centering.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-authored-by: Jean-Philippe Raynaud <jp.raynaud@gmail.com>
Co-authored-by: Jean-Philippe Raynaud <jp.raynaud@gmail.com>
Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com>
Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com>
Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com>
Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com>
Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com>
dalibran and others added 13 commits May 29, 2026 20:27
Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com>
Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com>
Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com>
- Rename page/sidebar label to "Light wallets" (sentence case)
- Move Use Cases dropdown to end of left navbar
- Remove unused spoCta note about IOG Discord membership
- Update browser support paragraph with compatibility link, example, and Rust crate link
- Remove "For wallet developers" title casing

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Remove specific security caveat content from the caution admonition,
replacing it with a neutral info admonition pointing to the Protocol
security page. Drop the Swift/Kotlin mobile bindings paragraph.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Adds a Bridges page under Use Cases following the same structure as
Light wallets. Wires it into the Use Cases navbar dropdown and mirrors
the page into the maintained docs version.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Introduce a Case Studies docs section with a Daedalus entry covering
Mithril-based initial sync, including navbar dropdown, sidebar, and
wordmark styling.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-authored-by: Jean-Philippe Raynaud <jp.raynaud@gmail.com>
Co-authored-by: Jean-Philippe Raynaud <jp.raynaud@gmail.com>
Replace the standalone Light Wallets page with a Wallets landing that
introduces both wallet shapes and surfaces the Light wallets integration
guide and the Daedalus case study as cards. Merge the separate Case
Studies section into Use Cases so the Daedalus study lives under
Wallets in the sidebar.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…framing

Apply lead-dev review feedback: promote Rust client library and CLI as the
primary integration path (with WASM scoped to browser-facing components),
rework the finality framing so it's clear the bridge sets its own
confirmation threshold under both current and upcoming Mithril certification,
tighten the "compromised provider" clause to name the concrete consequence,
and clarify the user-facing "aggregator" term with a 1inch example.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Add the with-Mithril sync figure (roughly 30 minutes to an hour, depending
on hardware and connection) to the "How Mithril helps" section, and replace
em dashes with commas across the page for a less stylized read.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…example

Extract the official DAEDALUS wordmark paths already embedded in daedalus-logo.svg
into a standalone SVG so the case-study page no longer needs the Montserrat font
import from Google Fonts. Add a sentence in the bridges integration section
pointing to the client-cardano-transaction example for the full Rust-library
proof flow.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@dalibran
dalibran removed the request for review from olgahryniuk May 29, 2026 14:14
The previous `npm run pretty:write` in docs/website only covered
**/*.{js,md} with prettier 3.3.2 (pinned). CI runs `prettier --check .`
from repo root with prettier 3.8.3 (latest, from `npm install -g`),
which formats a broader set of files and uses slightly different
markdown rules. Run repo-root prettier so the formatting matches what
CI checks.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@dalibran
dalibran merged commit d75cb7d into main May 29, 2026
45 of 46 checks passed
@dalibran
dalibran deleted the docs/use-cases branch May 29, 2026 14:35
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.

Improving Mithril Documentation

3 participants