[Plugin] - with/automatic-docs

  • Adds automatic Nextra MDX docs generation from schemas

npm run regenerate:docs
  • Automatics MDX docs for

    • Schemas (if put into a /schemas/ folder OR named .schema.ts)

    • Resolvers (using DataBridges → linking Input & Output schemas to logic)

    • Components (using Prop schemas → getDocumentationProps)

  • Picks up additional developer notes or custom docs

    • Look for {subject}.docs.mdx files

    • If {subject} matches a schema / resolver / component with auto-docs

      • Add the contents of .docs.mdx to the resulting Nextra MDX doc

    • If {subject} is not one of the above, create its own Nextra MDX doc page

  • Also sets the project up with `@app/docs` workspace

    • Includes all the official docs from fullproduct.dev/docs

    • /pages/ dir = Destination for all auto-generated docs

  • ✅ Easy onboardings and handovers

  • ✅ Docs will automatically grow as you build new features

Please authenticate to join the conversation.

Upvoters
Status

Completed

Board
💡

Features / Fixes

Date

7 months ago

Author

Thorr Stevens

Subscribe to post

Get notified by email when there are changes.