mirror of
https://github.com/agentrhq/authsome.git
synced 2026-09-19 01:34:19 +08:00
Manoj Bajaj
bdf659ffff
- cli.mdx: fix exit code table (all codes 2-9 were mapped to wrong errors); add profile command docs; add shell export format; fix --log-file default path; fix set-default to top-level command (not connection set-default); document --force/--yes distinction on register; update log command to describe tabular audit output and --raw flag; fix doctor check names; expand --quiet semantics note - manual-testing.md: fix doctor expected checks (config→spec_version/identity/ connections/integrity); fix log expected output (table not raw NDJSON); add --raw log test; fix connection set-default→set-default; fix --force register expected; fix ProviderNotFoundError exit code (3→4) and ConnectionNotFoundError note (exit 3) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Entire-Checkpoint: 12f601dab847
authsome docs
The Mintlify documentation site for authsome.
Local preview
Requires Node.js >=20.17.0.
npm i -g mint
mint dev
The site renders at http://localhost:3000 with hot reload.
Validate before committing
mint broken-links # check internal links
mint a11y # check accessibility issues
mint validate # run schema + content validation
Structure
docs/site/
docs.json Mintlify config: theme, navigation, navbar
index.mdx Landing page
quickstart.mdx First-run walkthrough
guides/ Task-oriented guides
concepts/ Architecture and core concepts
reference/ CLI, schema, env vars, bundled providers
troubleshooting/ Diagnostic pages
Adding a page
- Create the MDX file in the right subfolder.
- Add it to the appropriate
pageslist indocs.json. pages not referenced indocs.jsonare hidden from the sidebar. - Run
mint devto preview, thenmint broken-linksandmint validatebefore opening a PR.
Style
Match the surrounding pages:
- Sentence case for headings.
- Code blocks always have a language tag.
- Internal links use root-relative paths without file extensions:
/guides/login-with-oauth, not./login-with-oauth.mdx. - Prefer Mintlify components (
<Steps>,<CodeGroup>,<Tabs>,<Card>,<Columns>,<Tip>,<Warning>) over plain Markdown when they help.