-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationpriority/mediumMedium priorityMedium prioritysolution/toolkitAzureLocal ToolkitAzureLocal Toolkit
Description
Overview
Write comprehensive documentation covering the toolkit's purpose, all modules, integration guides for solution repos, and standards guides for naming conventions, tagging, and pipeline patterns.
Scope
docs/index.md— Toolkit overview and getting starteddocs/configuration/— Variable registry reference, schema documentationdocs/deployment/— Integration guide for consuming repos (PowerShell + Python)docs/standards/— Naming conventions, tagging policies, pipeline template usagedocs/roadmap.md— Toolkit maturity roadmap and future featuresdocs/contributing.md— How to add new variables, update standards, submit PRs
Acceptance Criteria
- Integration guide enables a new repo to consume the variable registry in <30 minutes
- All registry variables documented with type, description, and example
- Naming convention and tagging standards fully documented
- Pipeline template usage documented with copy-paste examples
- Docs site builds without warnings
Dependencies
- Parent Epic: [Epic] Azure Local Toolkit Platform Automation Full Build-Out #9
- Variable registry: feat: variable registry implementation (shared config for all solution repos) #10
- Standards replication: feat: standards replication mechanism across all solution repos #11
Priority Note
Priority/medium — documentation deferred until core modules stabilize.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationpriority/mediumMedium priorityMedium prioritysolution/toolkitAzureLocal ToolkitAzureLocal Toolkit