| file_type | documentation | |||
|---|---|---|---|---|
| title | LightSpeed .github Documentation Index | |||
| description | Comprehensive index and quickstart guide for all documentation in the .github repository | |||
| version | 1.1 | |||
| last_updated | 2026-06-01 | |||
| owners |
|
|||
| tags |
|
|||
| status | active | |||
| stability | stable | |||
| domain | governance | |||
| language | en |
Welcome to the comprehensive documentation hub for the LightSpeed .github repository. This is your central resource for understanding how to contribute, manage GitHub automation, and maintain the organisation's community health infrastructure.
- Read CONTRIBUTING.md — understand the contribution workflow
- Check BRANCHING_STRATEGY.md — learn about branch naming conventions
- Review ISSUE_CREATION_GUIDE.md — how to create effective issues
- Follow PR_CREATION_PROCESS.md — PR workflow and expectations
- Understand AUTOMATION.md — automation policies and governance
- Learn LABELING.md — label strategy and management
- Review RELEASE_PROCESS.md — release procedures
- Check GOVERNANCE_REVISION_LOG.md — recent policy changes
- Start AUTOMATION.md — GitHub Actions workflows and automation overview
- Review AGENT_CREATION.md — creating new agents/automation
- Understand AUTOMATION.md — governance framework and policies
- Explore GITHUB_PROJECT_OPERATIONS_SPEC.md — project operations
- ARCHITECTURE.md — Overall system architecture
- ORGANIZATION.md — Repository structure and organisation
- BRANCHING_STRATEGY.md — Git branching conventions
- VERSIONING.md — Version numbering strategy
- ROADMAP.md — Project roadmap and priorities
- AUTOMATION.md — GitHub Actions workflows and automation documentation
- PR_CREATION_PROCESS.md — Pull request workflow
- ISSUE_CREATION_GUIDE.md — Issue creation standards
- RELEASE_PROCESS.md — Release procedures
- MIGRATION.md — Migration and upgrade procedures
- LABELING.md — Comprehensive labeling guide covering:
- Label families and categories (status, priority, type, area, context, meta, contributor)
- Issue labelling requirements and automation
- Pull request labelling and branch mapping
- Discussion labelling guidelines
- ISSUE_TYPES.md — Issue type definitions and usage
- ISSUE-FIELDS.md — Issue field definitions
- AUTOMATION.md — Label governance and automation policies
- GITHUB_PROJECT_OPERATIONS_SPEC.md — Project board operations
- CONFIGS.md — Configuration files reference
- FRONTMATTER_SCHEMA.md — Frontmatter/metadata standards
- HUSKY_PRECOMMITS.md — Pre-commit hooks setup
- PLUGIN_INSTALLATION_GUIDE.md — Plugin installation
- PLUGIN_PACK_ROADMAP.md — Plugin development roadmap
- TESTING.md — Testing standards and frameworks
- LINTING.md — Linting rules and configuration
- AGENT_CREATION.md — Creating new agents and automation
- CROSS_PLATFORM_SKILL_YAML_SPEC.md — Skill specification
- AUTOMATION.md — Automation and governance policies
- GOVERNANCE_REVISION_LOG.md — Governance change history
- DECISIONS.md — Architecture Decision Records (ADRs)
- DISCUSSIONS.md — Discussion category guidelines
- override-policy.md — Override policies and procedures
- METRICS.md — Metrics tracking and reporting
- AWESOME_ALIGNMENT.md — Awesome project alignment
- SHARED_GITHUB_ADOPTION_GUIDE.md — Organisation-wide adoption guide
- downstream/tour-operator-adoption.md — Tour Operator specific adoption
| Role | Key Documents |
|---|---|
| Developer | CONTRIBUTING.md, BRANCHING_STRATEGY.md, TESTING.md, LINTING.md |
| Reviewer | PR_CREATION_PROCESS.md, LABELING.md, ISSUE_TYPES.md |
| Maintainer | AUTOMATION.md, RELEASE_PROCESS.md, LABELING.md |
| Automation/DevOps | AUTOMATION.md, AGENT_CREATION.md, CONFIGS.md |
| Organisation Lead | ROADMAP.md, GOVERNANCE_REVISION_LOG.md, DECISIONS.md |
| Task | Start Here |
|---|---|
| Create an issue | ISSUE_CREATION_GUIDE.md |
| Submit a PR | PR_CREATION_PROCESS.md |
| Create automation/agent | AGENT_CREATION.md |
| Manage labels | LABELING.md |
| Configure repository | CONFIGS.md |
| Release a version | RELEASE_PROCESS.md |
| Setup pre-commit hooks | HUSKY_PRECOMMITS.md |
| Understand project board | GITHUB_PROJECT_OPERATIONS_SPEC.md |
All documentation in this repository follows these standards:
- Language: UK English (colour, organisation, optimise)
- Format: Markdown with YAML frontmatter
- Links: Relative paths within repository
- Accessibility: WCAG 2.2 AA compliant
- Updates: Last updated dates maintained in frontmatter
See CONTRIBUTING.md for documentation contribution guidelines.
- CONTRIBUTING.md — Full contribution guidelines
- .github/custom-instructions.md — AI/Copilot instructions
- AGENTS.md — AI agent specifications
- instructions/ — Instruction files for various domains
- Check DISCUSSIONS.md for discussion guidelines
- Review CONTRIBUTING.md for contribution process
- Browse this index to find relevant documentation
- Check related issue templates in .github/ISSUE_TEMPLATE/
Last updated: 2026-05-31 Maintained by: LightSpeed Team
Docs signed by 🤖 Copilot for LightSpeedWP – always fresh!