Skip to content

[Community] Docs Repo Contributor Guidance #468

@mkmeral

Description

@mkmeral

Part of Community Health & Ecosystem Strategy

Problem

The docs repository has no CONTRIBUTING.md or contributor guidance. Documentation contributors don't know:

  • How to set up local preview
  • What the style guide is
  • How deployment works
  • What contributions are welcome

Requirements

CONTRIBUTING.md Content

  1. Getting Started

    • Clone repo
    • Install dependencies
    • Local preview setup (mkdocs serve or similar)
  2. What Contributions Are Welcome

    • Typo fixes
    • Clarifications
    • New tutorials/guides
    • API documentation improvements
    • Translations (if supported)
  3. Style Guide

    • Writing style (concise, technical but accessible)
    • Code example standards
    • Formatting conventions
    • Image/diagram guidelines
  4. PR Process

    • Branch naming
    • Commit message format
    • Review process
    • Deployment (automatic on merge? manual?)
  5. Content Structure

    • How docs are organized
    • Where to add new content
    • Navigation updates

Local Preview Instructions

Document how to:

  • Install mkdocs and dependencies
  • Run local server
  • Preview changes before submitting PR

Acceptance Criteria

  • CONTRIBUTING.md added to docs repo
  • Local preview instructions working
  • Style guide documented
  • PR process documented
  • Linked from unified contributor guide

Metadata

Metadata

Assignees

No one assigned

    Labels

    area-communityRelated to community and contributor health

    Type

    No type

    Projects

    Status

    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions