Docs Guidelines

Documentation guidelines

For contributing to the Prompty documentation:

1. Local Setup

   • Our documentation uses MDX (Markdown + JSX) and is built with a static site generator.
   • Install dependencies with npm install in the web directory.
   • Use Node.js 18+ for best compatibility.

2. Making Changes

   • User-facing documentation files are located in web/src/content/docs.
   • Follow the existing folder structure and naming conventions.
   • Use .mdx extension for all documentation files.

3. Previewing Changes

   • Start the local development server with npm run dev from the web directory.
   • View your changes at http://localhost:4321.
   • The site will hot-reload as you edit files.

4. Building Documentation

   • Test a production build with npm run build followed by npm run start.
   • Check for any build errors or warnings before submitting your PR.

5. Provider and runtime changes

   • Update provider guides when adding or changing OpenAI, Foundry, Anthropic, or custom provider behavior.
   • Update Discover Available Models when model-listing support changes.
   • Update Run Live Provider Tests when integration-test environment variables or skip behavior changes.
   • Cross-link new APIs from generated reference pages when users need narrative examples.

---

Want to Contribute To the Project?