Skip to content

Contributing to Documentation

Prerequisites

This guide assumes you are already familiar with our setup guide.

Create a new branch for your documentation changes: 

git checkout -b docs/your-feature-name

Previewing Documentation Changes

Local Development

  1. From the project root directory, start the MkDocs development server: 
    mkdocs serve
  2. Open your browser and navigate to http://127.0.0.1:8000

The preview will automatically update as you make changes to the documentation files.

Making Documentation Changes

Documentation Structure

  • Documentation source files are written in Markdown and located in the docs/ directory
  • Images and other assets should be placed in the docs/assets/ directory
  • The documentation structure is defined in mkdocs.yaml at the root of the repository

Submitting Your Changes

  1. Commit your changes with a descriptive message: 

    git add docs/
git commit -m "docs: describe your changes here"

  2. Push your changes to your fork: 

    git push origin docs/your-feature-name

  3. Create a Pull Request (PR) from your fork to the main recipe-scrapers repository.

PR Preview

When you create a PR, a special preview URL will be generated where your documentation changes can be reviewed. This will make it easy for maintainers to see your changes in action.

Documentation Style Guidelines

Style Guide

  • Use clear, concise language
  • Include code examples where appropriate
  • Follow the existing documentation structure
  • Add screenshots or diagrams when they help explain concepts
  • Ensure all links are working
  • Use proper Markdown formatting

Need Help?

Getting Support

If you have questions or need assistance with documentation contributions, please: