Skip to content

Add structured docs/ directory and copilot instructions for documentation maintenance#7208

Open
Copilot wants to merge 14 commits intomainfrom
copilot/modernize-repository-documentation
Open

Add structured docs/ directory and copilot instructions for documentation maintenance#7208
Copilot wants to merge 14 commits intomainfrom
copilot/modernize-repository-documentation

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 19, 2026

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 root

  • docs/concepts/ — Glossary, feature stages, alpha features
  • docs/guides/ — Contributing, adding commands, creating extensions, observability
  • docs/reference/ — Environment variables, azure.yaml schema, feature status table
  • docs/architecture/ — System overview, command execution model, extension framework, provisioning pipeline, ADR template

docs/README.md serves as the index with a placement guide:

Content type Location
Term or concept docs/concepts/glossary.md
Contributor how-to docs/guides/
Config reference docs/reference/
System design or ADR docs/architecture/
Implementation design 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

  • References, not duplication — new docs link to existing detailed docs in cli/azd/docs/ rather than copying content
  • No file moves — existing docs stay in place; this is an additive organizational layer
  • ADR-readydocs/architecture/adr-template.md provides 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.

Copilot AI linked an issue Mar 19, 2026 that may be closed by this pull request
1 task
Copilot AI changed the title [WIP] Update repository documentation for contributor and agent development Add structured docs/ directory and copilot instructions for documentation maintenance Mar 19, 2026
Copilot AI requested a review from spboyer March 19, 2026 14:29
@spboyer spboyer marked this pull request as ready for review March 19, 2026 14:54
Copilot AI review requested due to automatic review settings March 19, 2026 14:54
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md index and a set of new concept/guide/reference/architecture documents.
  • Adds .github/instructions/documentation.instructions.md to guide agents/contributors on when/where to update documentation.
  • Updates root README.md to link contributors to the new docs/ 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.

Comment thread docs/reference/environment-variables.md Outdated
Comment thread docs/reference/azure-yaml-schema.md
Comment thread docs/guides/contributing.md
Comment thread README.md Outdated
Comment thread docs/guides/observability.md Outdated
Copilot AI and others added 4 commits March 20, 2026 13:02
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>
@spboyer spboyer force-pushed the copilot/modernize-repository-documentation branch from d8c42fe to 212d209 Compare March 20, 2026 17:02
Comment thread .github/instructions/documentation.instructions.md
Copy link
Copy Markdown
Member

@jongio jongio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread docs/reference/environment-variables.md Outdated
Comment thread docs/reference/environment-variables.md Outdated
Comment thread docs/guides/adding-a-new-command.md Outdated
@microsoft-github-policy-service microsoft-github-policy-service bot added the no-recent-activity identity issues with no activity label Apr 6, 2026
@hemarina
Copy link
Copy Markdown
Contributor

@copilot Address all comment

@microsoft-github-policy-service microsoft-github-policy-service bot removed the no-recent-activity identity issues with no activity label Apr 13, 2026
… 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>
Copy link
Copy Markdown
Member

@jongio jongio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed the latest commit (e90fc9c) which fixed my 3 previous findings. Found 5 new factual accuracy issues - capability names, method signatures, and completeness gaps that could mislead contributors.

Comment thread docs/architecture/extension-framework.md Outdated
Comment thread docs/guides/adding-a-new-command.md Outdated
Comment thread docs/architecture/provisioning-pipeline.md Outdated
Comment thread docs/reference/azure-yaml-schema.md
Comment thread docs/architecture/system-overview.md
Copy link
Copy Markdown
Member

@spboyer spboyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.OutputFormatJson don't exist; actual types are output.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

Comment thread docs/architecture/command-execution-model.md Outdated
Comment thread docs/architecture/command-execution-model.md Outdated
Comment thread docs/reference/feature-status.md
Comment thread docs/concepts/alpha-features.md Outdated
Copy link
Copy Markdown
Member

@jongio jongio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread docs/guides/creating-an-extension.md
Comment thread docs/concepts/glossary.md
Comment thread docs/guides/adding-a-new-command.md
 - 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
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 existing cli/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.

Comment thread docs/architecture/command-execution-model.md Outdated
Comment thread docs/guides/adding-a-new-command.md Outdated
Comment thread docs/guides/adding-a-new-command.md
Comment thread docs/reference/feature-status.md Outdated
Comment thread docs/reference/environment-variables.md Outdated
Comment thread docs/reference/environment-variables.md
@hemarina hemarina self-assigned this Apr 16, 2026
…, 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>
@hemarina hemarina requested review from jongio, spboyer and vhvb1989 April 16, 2026 02:21
Copy link
Copy Markdown
Member

@jongio jongio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Three new factual accuracy issues not covered by existing feedback. Nine issues from prior rounds remain unaddressed.

Comment thread docs/architecture/provisioning-pipeline.md
Comment thread docs/reference/azure-yaml-schema.md Outdated
Comment thread docs/concepts/glossary.md
hemarina and others added 2 commits April 16, 2026 14:42
…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>
Copy link
Copy Markdown
Member

@jongio jongio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Latest commit addresses most of my round 4 feedback, but the hook list change introduced a new issue. Two things:

  1. infracreate/infradelete aren't valid hook names.
  2. The preflight description in the glossary overstates server-side involvement.

Details inline.

Comment thread docs/reference/azure-yaml-schema.md Outdated
Comment thread docs/concepts/glossary.md Outdated
hemarina and others added 2 commits April 16, 2026 20:53
Co-authored-by: Jon Gallant <2163001+jongio@users.noreply.github.com>
Co-authored-by: Jon Gallant <2163001+jongio@users.noreply.github.com>
@hemarina hemarina requested a review from jongio April 17, 2026 04:42
Copy link
Copy Markdown
Member

@jongio jongio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Modernize repository documentation for contributor and agent development

6 participants