Add structured docs/ directory and copilot instructions for documentation maintenance#7208
Add structured docs/ directory and copilot instructions for documentation maintenance#7208
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a structured root-level docs/ directory (concepts/guides/reference/architecture) plus Copilot documentation-maintenance instructions, and wires the new docs index from the root README to improve contributor navigation.
Changes:
- Introduces a new
docs/README.mdindex and a set of new concept/guide/reference/architecture documents. - Adds
.github/instructions/documentation.instructions.mdto guide agents/contributors on when/where to update documentation. - Updates root
README.mdto link contributors to the newdocs/directory.
Reviewed changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/reference/feature-status.md | Adds a feature maturity reference table for commands/languages/hosts/etc. |
| docs/reference/environment-variables.md | Adds a consolidated environment variable reference (high-level) with pointer to implementation docs. |
| docs/reference/azure-yaml-schema.md | Adds a high-level azure.yaml schema overview and links to the machine-readable schema. |
| docs/guides/observability.md | Adds contributor guidance for tracing/telemetry and links to detailed docs. |
| docs/guides/creating-an-extension.md | Adds a step-by-step extension authoring guide and links to detailed docs. |
| docs/guides/contributing.md | Adds a contributor workflow guide (build/test/lint/checklist). |
| docs/guides/adding-a-new-command.md | Documents the ActionDescriptor pattern and command registration workflow. |
| docs/concepts/glossary.md | Adds a glossary of key terms used in the codebase. |
| docs/concepts/feature-stages.md | Defines alpha/beta/stable stages and links to feature status. |
| docs/concepts/alpha-features.md | Documents enabling/discovering alpha features and pointers to implementation details. |
| docs/architecture/system-overview.md | Adds a high-level architecture overview and directory map. |
| docs/architecture/provisioning-pipeline.md | Documents the provisioning pipeline and links to deeper design docs. |
| docs/architecture/extension-framework.md | Documents gRPC extension architecture and capabilities. |
| docs/architecture/command-execution-model.md | Documents command registration/build/middleware/action execution model. |
| docs/architecture/adr-template.md | Adds an ADR template for future architecture decisions. |
| docs/README.md | Adds the new docs landing page and “where do new docs go?” routing table. |
| README.md | Adds link to docs/README.md for contributor documentation. |
| .github/instructions/documentation.instructions.md | Adds Copilot instructions for ongoing documentation maintenance. |
You can also share your feedback on Copilot code review. Take the survey.
Create docs/ at repo root with concepts/, guides/, reference/, and architecture/ subdirectories. Add initial documentation covering: - Glossary, feature stages, alpha features (concepts) - Contributing, adding commands, creating extensions, observability (guides) - Environment variables, azure.yaml schema, feature status (reference) - System overview, command execution, extension framework, provisioning (architecture) - ADR template for future architecture decision records Add .github/instructions/documentation.instructions.md with copilot instructions to keep docs up to date when codebase changes. Update root README.md to link to the new docs/ directory. Co-authored-by: spboyer <7681382+spboyer@users.noreply.github.com>
Co-authored-by: spboyer <7681382+spboyer@users.noreply.github.com>
- Add cspell overrides for technical terms in docs/ markdown files - Fix Jaeger OTLP endpoint to use explicit http://localhost:4318 - Update AGENTS.md link in README.md to root (symlink) - Verified errors.AsType is valid (Go 1.26, used in 10+ files) - Verified table syntax is correct (no || issues found) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
d8c42fe to
212d209
Compare
jongio
left a comment
There was a problem hiding this comment.
Reviewed 19 changed files. Found 3 issues (1 HIGH, 2 MEDIUM) not covered by existing feedback. Cross-references all valid. Feature status claims verified accurate. Table syntax issues from earlier Copilot bot comments appear fixed in later commits.
|
@copilot Address all comment |
… descriptions - Remove hallucinated AZD_DEBUG_DOTENV_OVERRIDES, replace with real AZD_DEBUG_LOG - Move AZD_AUTH_ENDPOINT/AZD_AUTH_KEY to new "IDE Integration" section with accurate descriptions (set by IDE hosts, not user-facing) - Add missing github.com/spf13/pflag import to code example in adding-a-new-command.md Agent-Logs-Url: https://github.com/Azure/azure-dev/sessions/6fcebb42-32ec-4d91-a394-7e4f5b46a3fd Co-authored-by: hemarina <104857065+hemarina@users.noreply.github.com>
spboyer
left a comment
There was a problem hiding this comment.
Docs restructuring is a welcome improvement. jongio's two review rounds caught the major factual issues (capability names, IoC pattern, hooks, Bind signature). Found 4 additional factual accuracy issues in files not yet covered by existing threads.
- command-execution-model.md:22 —
actions.OutputFormat/actions.OutputFormatJsondon't exist; actual types areoutput.Format/output.JsonFormat - command-execution-model.md:60 — ActionResult description misrepresents the struct shape
- feature-status.md:7 — Missing 7+ commands from the canonical feature-stages table (init, auth, help, version, show, update, infra generate)
- alpha-features.md:49 — References a nonexistent "experiments section" in the changelog
jongio
left a comment
There was a problem hiding this comment.
Third round - checked files with no existing feedback. Found 3 more factual accuracy issues, same category as before (identifiers that don't match the codebase). 9 issues from my second review and spboyer's review are still unaddressed.
- extension-framework, creating-an-extension, glossary: correct capability names to match extension.schema.json (custom-commands, lifecycle-events, mcp-server, service-target-provider, framework-service-provider, metadata) - creating-an-extension: fix extension ID (microsoft.azd.extensions), YAML field (id: not name:), list all supported languages - command-execution-model: fix OutputFormat types, ActionResult description, add NoneFormat - adding-a-new-command: fix Bind signature, file path, root.Add - system-overview: fix IoC pattern to constructor injection - provisioning-pipeline: remove hallucinated preflight checks - azure-yaml-schema: fix host values (ai.endpoint, azure.ai.agent), add missing properties, hooks, languages, service fields - environment-variables: fix AZD_DEBUG_LOG description - feature-status: add missing commands, match canonical naming - alpha-features: add unset/disable commands, env var notation - feature-stages: fix graduation criteria per canonical source - observability: fix Span/Event terminology, add localhost note - glossary: fix preflight checks to include server-side validation
There was a problem hiding this comment.
Pull request overview
Adds a root-level docs/ hierarchy to centralize contributor/agent documentation and introduces Copilot instructions to keep documentation updated as the codebase evolves.
Changes:
- Introduces a new structured
docs/index and sub-sections (concepts/guides/reference/architecture) without moving existingcli/azd/docs/content. - Adds documentation maintenance instructions for Copilot at
.github/instructions/documentation.instructions.md. - Updates repo entry points (README + cspell overrides) to route contributors to the new documentation structure.
Reviewed changes
Copilot reviewed 19 out of 19 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/README.md | Adds a docs index + placement guide for where new documentation should live. |
| docs/concepts/glossary.md | Defines core terminology used across the azd codebase. |
| docs/concepts/feature-stages.md | Describes alpha/beta/stable definitions and graduation criteria. |
| docs/concepts/alpha-features.md | Documents how to enable/discover alpha features and CI env var patterns. |
| docs/guides/contributing.md | Adds contributor workflow guidance (build/test/lint/pre-commit). |
| docs/guides/adding-a-new-command.md | Documents the ActionDescriptor-based workflow for adding commands. |
| docs/guides/creating-an-extension.md | Provides an extension creation/publishing guide and links to detailed extension docs. |
| docs/guides/observability.md | Adds a tracing/telemetry guide and links to existing detailed docs. |
| docs/reference/environment-variables.md | Introduces a root-level entry point for env var documentation (with links to detailed reference). |
| docs/reference/azure-yaml-schema.md | Provides a high-level schema overview and links to JSON schema sources. |
| docs/reference/feature-status.md | Adds a simplified feature maturity table and links to the existing tracking table. |
| docs/architecture/system-overview.md | Summarizes azd system layout and key subsystems. |
| docs/architecture/command-execution-model.md | Documents command registration/execution pipeline concepts. |
| docs/architecture/extension-framework.md | Summarizes extension discovery/lifecycle/capabilities at a high level. |
| docs/architecture/provisioning-pipeline.md | Summarizes provisioning stages and links to detailed design docs. |
| docs/architecture/adr-template.md | Adds an ADR template for recording decisions. |
| .github/instructions/documentation.instructions.md | Adds Copilot guidance on when/where to update docs as code changes. |
| README.md | Updates contributor routing to point to root AGENTS.md and the new docs/ index. |
| .vscode/cspell.misc.yaml | Adds cspell overrides for new docs/ markdown content. |
…, TTY description, add AZD_AUTH_CERT - command-execution-model.md: clarify OutputFormats wires flags only; actions emit structured output via injected output.Formatter - adding-a-new-command.md: convert code example to tab indentation (gofmt), add note that OutputFormats alone is insufficient - feature-status.md: remove misleading 'with graduation criteria' from link text - environment-variables.md: fix AZD_FORCE_TTY description to 'terminal detection mode', add missing AZD_AUTH_CERT env var Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
jongio
left a comment
There was a problem hiding this comment.
Three new factual accuracy issues not covered by existing feedback. Nine issues from prior rounds remain unaddressed.
…7208-review-feedback
…fix IoC regression, update glossary - provisioning-pipeline.md: add ai_model_quota as second preflight check - azure-yaml-schema.md: shell→kind in hook example, add infracreate/infradelete hooks - system-overview.md: fix IoC example regression (MustRegisterTransient→MustRegisterSingleton) - glossary.md: update preflight description to match implemented checks Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
jongio
left a comment
There was a problem hiding this comment.
Latest commit addresses most of my round 4 feedback, but the hook list change introduced a new issue. Two things:
infracreate/infradeletearen't valid hook names.- The preflight description in the glossary overstates server-side involvement.
Details inline.
Co-authored-by: Jon Gallant <2163001+jongio@users.noreply.github.com>
Co-authored-by: Jon Gallant <2163001+jongio@users.noreply.github.com>
jongio
left a comment
There was a problem hiding this comment.
Round 6 - checked the two latest commits. Hook list now matches knownHookNames in cmd/hooks.go:126-143 exactly, and the preflight description no longer overstates server-side involvement. All factual issues I raised across prior rounds look resolved. No new findings.
Repository documentation is scattered across
cli/azd/docs/,AGENTS.md, and various READMEs with no consistent organization by purpose. Contributors and agents have no clear routing for where to find or place documentation.New
docs/structure at repo rootdocs/concepts/— Glossary, feature stages, alpha featuresdocs/guides/— Contributing, adding commands, creating extensions, observabilitydocs/reference/— Environment variables, azure.yaml schema, feature status tabledocs/architecture/— System overview, command execution model, extension framework, provisioning pipeline, ADR templatedocs/README.mdserves as the index with a placement guide:docs/concepts/glossary.mddocs/guides/docs/reference/docs/architecture/cli/azd/docs/design/Copilot instructions
Added
.github/instructions/documentation.instructions.md— tells Copilot when and where to update docs as code changes (new env vars, feature stage changes, new capabilities, etc.).Design choices
cli/azd/docs/rather than copying contentdocs/architecture/adr-template.mdprovides a lightweight template for future decision records⌨️ Start Copilot coding agent tasks without leaving your editor — available in VS Code, Visual Studio, JetBrains IDEs and Eclipse.