CONTRIBUTING.md

Contributing to YGIT Documentation

Content workflow

1. Create or update Markdown/MDX in the correct documentation surface.
2. Add title and description front matter.
3. Use one topic per page and task-oriented headings.
4. Verify all steps against the current product.
5. Remove account names, tokens, internal URLs, and operational identifiers from screenshots and examples.
6. Run the validation suite.

npm install
npm run validate

Directory ownership

Directory	Purpose
docs/	End-user documentation
cli/	YGIT CLI documentation
sdk/	Official SDK documentation
api/	Public API documentation
updates/	Public release notes and announcements
static/img/	Public-safe images and brand assets

Writing standard

• Prefer concrete steps over marketing claims.
• State prerequisites and expected results.
• Mark unavailable or preview functionality clearly.
• Use relative links between documentation pages.
• Use descriptive alt text for images.
• Do not publish internal architecture unless it is deliberately rewritten and approved as public architecture.