Skip to content

docs: initialize Mintlify documentation site#8

Open
0xdevcollins wants to merge 3 commits into
kalepail:mainfrom
0xdevcollins:docs/mintlify-setup
Open

docs: initialize Mintlify documentation site#8
0xdevcollins wants to merge 3 commits into
kalepail:mainfrom
0xdevcollins:docs/mintlify-setup

Conversation

@0xdevcollins

@0xdevcollins 0xdevcollins commented Apr 11, 2026

Copy link
Copy Markdown

Summary

  • Adds docs/mint.json - Mintlify config with navigation, colors, and branding
  • Adds 22 MDX pages covering the full SDK surface (getting started, API reference, guides, advanced topics, and migration)
  • Converts the existing docs/migration-smart-account-kit-v0.7.0-rc.2.md content into a structured Mintlify migration page

Pages added

Getting Started

  • introduction.mdx - Overview, features, architecture diagram
  • quickstart.mdx - Install, initialize, create wallet, connect, transfer, disconnect
  • configuration.mdx - All SmartAccountConfig options with descriptions

API Reference

  • smart-account-kit.mdx - Full SmartAccountKit class (lifecycle, tx methods, discovery, raw escape hatch)
  • signer-manager.mdx, context-rule-manager.mdx, policy-manager.mdx
  • credential-manager.mdx, multi-signer-manager.mdx, external-signer-manager.mdx

Guides

  • storage-adapters.mdx, fee-sponsoring.mdx, multi-sig.mdx, events.mdx, error-handling.mdx

Advanced

  • builder-functions.mdx, relayer-client.mdx, indexer-client.mdx, wallet-adapters.mdx

Migration

  • migration/v0.7.0.mdx - v0.7.0-rc.2 breaking changes and migration steps

Test plan

  • Connect repo to mintlify.com pointing at docs/
  • Verify navigation renders correctly from mint.json
  • Spot-check code examples against current SDK source

Adds a full Mintlify docs structure under docs/ covering the complete
SDK surface  getting started, API reference, guides, and migration.
@0xdevcollins

Copy link
Copy Markdown
Author

@kalepail I converted some of the readme a mintlify docs.. you can checkout the implementation here as well before merging https://collinsboundlessfixyz.mintlify.app/introduction

Adds five SKILL.md files, a discovery index, and an AI/Skills docs page
so AI agents can discover and use the SDK via the agentskills.io protocol.

Skills added:
- smart-account-kit (SDK init, config, sub-managers)
- create-stellar-wallet (wallet creation workflow)
- sign-stellar-transactions (signing and submission)
- manage-signers (signers and context rules)
- setup-policies (threshold, spending limits, weighted voting)
@devin-ai-integration

Copy link
Copy Markdown

Thanks for putting this together — having proper docs on Mintlify is a meaningful upgrade over just the README. The structure is solid and the API reference pages check out against the actual source. A few things to address before this is ready to merge:

What works well:

  • The Mintlify navigation structure is well-organized — getting started → API reference → guides → advanced → migration is a natural flow.
  • I cross-checked the API reference against the current source code: sub-manager property names (kit.signers, kit.rules, kit.policies, etc.), error classes, exports, and method signatures all match. Nice attention to detail.
  • The quickstart and error-handling guides are genuinely useful with copy-paste-ready examples.
  • The migration page properly converts the existing migration-smart-account-kit-v0.7.0-rc.2.md content.

Things to address:

1. Agent skills should be a separate PR

The last two commits (d5b89a7, e647ee5) add .mintlify/skills/ with 5 SKILL.md files, .well-known/agent-skills/index.json, and an ai/skills.mdx page. This is a whole feature (agentskills.io integration with CLI tooling) — not documentation. It adds complexity that deserves its own review and discussion.

I'd suggest splitting those commits into a follow-up PR. It'll also make this PR easier to review and merge on its own merits.

2. Missing favicon.svg

mint.json references /favicon.svg but the file isn't included in the PR. This will show a broken favicon on the deployed site.

3. Skill metadata authorship

The skill files set metadata.author: kalepail — since you're not the repo owner, this should either be set to your own username or left for the maintainer to decide. Small thing, but worth getting right.

4. Guide pages could be deeper

Several guides (events, storage adapters, fee sponsoring) are fairly thin — mostly reformatted README content. They'd benefit from real-world context that goes beyond the basics:

  • Storage adapters: What happens when IndexedDB is blocked in a private/incognito tab? How should apps handle the fallback?
  • Fee sponsoring: What does relayer error recovery look like? What happens if the relayer is down — does the SDK fall back to RPC automatically?
  • Events: A practical example showing how to wire up event listeners in a React component lifecycle would help.

These aren't blockers for the initial merge, but they'd make the difference between docs that people skim and docs that people actually reference.

5. Skills reference a URL that doesn't exist yet

The skills page and CLI examples reference https://smart-account-kit.mintlify.app/ — this won't resolve until Mintlify is actually connected to the repo. Worth adding a note about this, or deferring the skills page until the site is live.


Overall this is a solid foundation. Splitting out the agent-skills commits and fixing the favicon would get this to a mergeable state. The guide depth improvements can be iterative.

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