Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
31 lines (22 loc) · 1.28 KB

CONTRIBUTING.md

File metadata and controls

31 lines (22 loc) · 1.28 KB
Raw

Contribute to the documentation

Thank you for your interest in contributing to our documentation! This guide will help you get started.

How to contribute

Option 1: Edit directly on GitHub

  1. Navigate to the page you want to edit
  2. Click the "Edit this file" button (the pencil icon)
  3. Make your changes and submit a pull request

Option 2: Local development

  1. Fork and clone this repository
  2. Create a branch for your changes
  3. Set up the tooling — either run flox activate (this repo ships a Flox environment that installs the Mintlify CLI for you) or install it directly with npm i -g mint
  4. Make your changes
  5. Run mint dev and preview at http://localhost:3000
  6. Commit your changes and submit a pull request

For setup details and useful commands, see the Local development section of the README.

Writing guidelines

  • Use active voice: "Run the command" not "The command should be run"
  • Address the reader directly: Use "you" instead of "the user"
  • Keep sentences concise: Aim for one idea per sentence
  • Lead with the goal: Start instructions with what the user wants to accomplish
  • Use consistent terminology: Don't alternate between synonyms for the same concept
  • Include examples: Show, don't just tell