Skip to main content
← back to extensions

Mintlify

@usefulish/mintlifyv2026.09.20.2· 1d agoMODELSWORKFLOWSREPORTS
01README

Turn any repository checkout into a validated Mintlify documentation site — inspect, plan, author with a locally installed coding agent, reconcile docs.json, and gate on the published Mintlify schema.

02Models1
@usefulish/mintlifyv2026.09.20.2mintlify.ts
fn inspect()
Profile a repository checkout — identity, languages, manifests, entrypoints, markdown outline, and any existing docs
fn plan()
Derive the documentation page set and per-page authoring briefs from the repository profile
fn author()
Write the planned documentation pages using a supported locally installed coding-agent provider
fn ensureConfig()
Create or update docs.json, regenerating navigation from the documentation pages present on disk
fn validate()
Validate docs.json against Mintlify's published schema and check page frontmatter, internal links, assets, and navigation reachability

Resources

repoProfile(infinite)— Deterministic profile of an inspected repository — identity, languages, manifests, entrypoints, markdown outline, existing docs
docsPlan(infinite)— The documentation page set derived from a repository profile, with per-page authoring briefs
authorRun(infinite)— Result of an authoring agent run — exit status, cost, and the docs files it changed
docsConfig(infinite)— The reconciled Mintlify docs.json — navigation regenerated from the pages present on disk
validation(infinite)— Documentation validation result — schema conformance, link integrity, frontmatter, and reachability findings

Files

agentLog(text/plain)— Full stdout and stderr from an authoring agent run
03Workflows1
@usefulish/mintlify-docs07e169be-ef6e-405a-b62a-8714788d38c5

Generate a validated Mintlify documentation site for a GitHub repository. Checks the repository out into a disposable workspace, profiles it, plans a page set, writes the pages with a locally installed coding agent, reconciles docs.json against what landed on disk, and gates on Mintlify's published schema plus link, frontmatter, and reachability checks. Nothing is committed or pushed — the run leaves the workspace checkout staged and ready to commit.

checkoutPut a clean checkout of the target repository in the workspace
1.ensure-checkout— Clone the repository, or reset an existing workspace checkout to the remote ref
documentProfile the repository, plan the pages, write them, and build the config
1.inspect— Profile the checkout — languages, manifests, entrypoints, markdown outline, existing docs
2.plan— Derive the documentation page set and per-page authoring briefs
3.author— Write the planned pages with a locally installed coding agent
4.ensure-config— Create or update docs.json, regenerating navigation from the pages on disk
verifyGate on documentation quality and report what is ready to commit
1.validate— Validate docs.json against Mintlify's schema and check links, frontmatter, and reachability
2.ready-to-commit— Show the documentation changes staged in the workspace checkout
04Reports1
@usefulish/mintlify-summarymethod
mintlify_docs.ts

Summarise a documentation factory run — validation findings, authoring cost, and navigation coverage

docsmintlifyquality
05Stats
A
100 / 100
Downloads
0
Archive size
128.7 KB
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License declared1/1earned
  • Verified public repository2/2earned
Repository
https://github.com/usefulish/documentation-factory
06Platforms
07Labels
#documentation#mintlify#docs#mdx#agent