Documentation Standards

Wiki-first documentation policy.

Policy

Documentation lives in Gitea wiki pages, not README files. READMEs contain only:

Project name and badges
One-paragraph description
Installation quick-start
Link to wiki for full docs
Contributing link
License

Wiki Structure

Every repo wiki should have at minimum:

Home - overview and navigation
Installation - setup instructions
Configuration - settings reference

File Headers

All source files include SPDX headers with DEFGROUP/INGROUP/REPO/PATH/BRIEF. See File Header Standards.

Inline Documentation

PHPDoc on all public methods
@param, @return, @throws, @since tags
Explain WHY in comments, not WHAT

CHANGELOG.md

Required in every repo. Follow Keep a Changelog format. Update as work progresses.

Pages

ARCHITECTURE
BULK-OPERATIONS
CLI-AUTOMATION
DEPLOY-SCRIPTS
DRY-RUN-PATTERN
Documentation-Standards
File-Header-Standards
Home
JOOMLA-SYNC
MINIFICATION
MONITORING-SCRIPTS
NEW-SCRIPTS
QUICKSTART-ORG-PROJECTS
RELEASE-MANAGEMENT
RUNNERS
VALIDATION
Version-Standard
WORKFLOW-STANDARDS
api
- api-automation-index
- api-definitions-default-index
- api-definitions-sync-index
- api-deploy-index
- api-fix-index
- api-index
- api-maintenance-index.-
- api-maintenance-index
- api-plugin-index.-
- api-plugin-index
- api-tests-index.-
- api-tests-sample-index.-
- api-tests-sample-index
- api-validate-index.-
- maintenance-index
automation
- automation-README.-
- automation-branch-version-automation.-
- automation-push-files.-
- automation-repo-cleanup.-
features
- AUTO-BUMP
- JOOMLA-SYNC
- JOOMLA_SYNC
- MANIFEST-STANDARD
- MINIFICATION
- UPDATE-SERVER
- Update-Server-Migration-Protocol
guides
- ARCHITECTURE
- AUTO-CREATE-ORG-PROJECTS
- AUTO_CREATE_ORG_PROJECTS
- DRY-RUN-PATTERN
- DRY_RUN_PATTERN
- QUICKSTART-ORG-PROJECTS
- QUICKSTART_ORG_PROJECTS
operations
- DEPLOY-SCRIPTS
- DEPLOY_SCRIPTS
- MONITORING-SCRIPTS
- MONITORING_SCRIPTS
- NEW-SCRIPTS
- NEW_SCRIPTS
- client-repos.-.-
- client-repos
reference
- CLI-AUTOMATION
- CLI_AUTOMATION
- DOLIBARR-MODULE-IDS
- DOLIBARR_MODULE_IDS
- LEGAL-DOC-GENERATOR-WEB-README
- LEGAL_DOC_GENERATOR_WEB_README
- unnamed
standards
- Branching-Strategy
- Coding-Standards
- Documentation-Standards
- File-Header-Standards
- WIKI-STANDARDS
- WIKI_STANDARDS
- WORKFLOW-STANDARDS
- WORKFLOW_STANDARDS
- standards-mokostandards-file-spec.-
- standards-mokostandards-file-spec
templates
- templates-client-waas
- templates-dolibarr
- templates-generic
- templates-mcp
workflows
- workflows-README.-
- workflows-README
- workflows-auto-release.-
- workflows-auto-release
- workflows-branch-protection.-
- workflows-branch-protection
- workflows-build-release.-
- workflows-build-release
- workflows-cascade-dev.-
- workflows-cascade-dev
- workflows-changelog-management.-
- workflows-changelog-management
- workflows-demo-deployment.-
- workflows-demo-deployment
- workflows-dev-branch-tracking.-
- workflows-dev-branch-tracking
- workflows-dev-deployment.-
- workflows-dev-deployment
- workflows-index.-
- workflows-index
- workflows-release-system.-
- workflows-release-system
- workflows-renovate.-
- workflows-renovate
- workflows-reusable-workflows.-
- workflows-reusable-workflows
- workflows-rs-deployment.-
- workflows-rs-deployment
- workflows-secret-scanning.-
- workflows-secret-scanning
- workflows-shared-workflows.-
- workflows-shared-workflows
- workflows-standards-compliance.-
- workflows-standards-compliance
- workflows-static-analysis.-
- workflows-static-analysis
- workflows-sub-issue-management.-
- workflows-sub-issue-management
- workflows-update-server.-
- workflows-update-server
- workflows-workflow-architecture.-
- workflows-workflow-architecture