Documentation

This section will tell you how to contribute documentation to Garden Linux and its associated projects and what metrics we use to assess whether documentation is good.

Available Documentation documentation

Documentation WorkflowHow to Contribute Documentation to Garden Linux

Documentation Quality MarkersWriting Good Documentation

Adding Repositories to Documentation AggregationGuide for adding new repositories to the documentation aggregation system

Documentation Aggregation ArchitectureDeep dive into how the documentation aggregation system works

Documentation Aggregation Configuration ReferenceComplete reference for repos-config.json and repos-config.local.json configuration options

Documentation Aggregation Technical ReferenceSource code documentation for the documentation aggregation system - modules, APIs, and implementation details

Documentation Aggregation Testing GuideTest suite for documentation - unit tests, integration tests, and testing best practices

Contributing to the Garden Linux DocumentationLearn how to contribute to Garden Linux documentation — working with the aggregation system locally