generated from amazon-archives/__template_Apache-2.0
-
Notifications
You must be signed in to change notification settings - Fork 166
Open
Labels
area-communityRelated to community and contributor healthRelated to community and contributor health
Description
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
-
Getting Started
- Clone repo
- Install dependencies
- Local preview setup (mkdocs serve or similar)
-
What Contributions Are Welcome
- Typo fixes
- Clarifications
- New tutorials/guides
- API documentation improvements
- Translations (if supported)
-
Style Guide
- Writing style (concise, technical but accessible)
- Code example standards
- Formatting conventions
- Image/diagram guidelines
-
PR Process
- Branch naming
- Commit message format
- Review process
- Deployment (automatic on merge? manual?)
-
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
Labels
area-communityRelated to community and contributor healthRelated to community and contributor health
Type
Projects
Status
Backlog