mirror of
https://github.com/agentrhq/authsome.git
synced 2026-09-19 01:34:19 +08:00
Priyansh Khodiyar
7c577abe64
Path 2 now offers two tracks: GitHub + OpenAI for users who want a runnable demo, and Notion via MCP for the zero-setup case (DCR auto-registers a client, no OAuth app needed). Each track is a tab. The GitHub + OpenAI track ends in a minimal agent script that stars agentrhq/authsome and asks gpt-5 to write a one-line celebration. It uses only the standard library so there's nothing to pip install. The script lives inside an Accordion so it doesn't dominate the page for readers who only want to see how the login flow works. Also clarifies what the OAuth bridge stores versus the access token GitHub returns, since that confused readers who thought they'd need a separate PAT to make API calls.
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.