Skip to content

Improve expansion internals documentation with high-level flow diagram and code references#3716

Open
Copilot wants to merge 6 commits intomainfrom
copilot/improve-documentation-expansion-internals
Open

Improve expansion internals documentation with high-level flow diagram and code references#3716
Copilot wants to merge 6 commits intomainfrom
copilot/improve-documentation-expansion-internals

Conversation

Copy link
Contributor

Copilot AI commented Mar 25, 2026

  • Analyze existing docs/license-contributing/expansion-internals.md and understand what's missing
  • Add mermaid diagram support to mkdocs.yml
  • Update expansion-internals.md with:
    • High-level flow diagram (mermaid flowchart)
    • "Key components" table with source file references (wrapped in !!! Implementation admonition)
    • Code file references in Building Bicep, Visiting definitions, Ordering resources, Evaluating expressions sections (wrapped in !!! Implementation admonitions)
  • Update docs/license-contributing/index.md to add link to expansion-internals
  • Update docs/changelog.md with entry for issue Improve documentation for expansion internals #3715
Original prompt

This section details on the original issue you should resolve

<issue_title>Improve documentation for expansion internals</issue_title>
<issue_description>Expand docs for contributions to map out a high level flow of. How expansion works and steps through processing Bicep code. </issue_description>

Comments on the Issue (you are @copilot in this section)


💬 Send tasks to Copilot coding agent from Slack and Teams to turn conversations into code. Copilot posts an update in your thread when it's finished.

Copilot AI changed the title [WIP] Update documentation for expansion internals Improve expansion internals documentation with high-level flow diagram and code references Mar 25, 2026
Copilot AI requested a review from BernieWhite March 25, 2026 07:37
@BernieWhite
Copy link
Collaborator

@copilot For cases that are extended references to code or class implementations use the implementation admonition.

Do this ben creating a block such as:

!!! Implementation
    Further details and class references here.
    Second line.

Copy link
Contributor Author

Copilot AI commented Mar 25, 2026

@copilot For cases that are extended references to code or class implementations use the implementation admonition.

Do this ben creating a block such as:
...

Done in c0032a2. All extended code/class reference blocks — the key components table, BicepHelper details, lazy-loading classes, ResourceDependencyGraph, and the expression evaluation classes list — have been wrapped in !!! Implementation admonitions.

@BernieWhite BernieWhite marked this pull request as ready for review March 25, 2026 18:02
@BernieWhite BernieWhite requested a review from a team as a code owner March 25, 2026 18:02
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.

Improve documentation for expansion internals

2 participants