Skip to content

Implement Bicep module documentation generation #20183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Jared Holgate (jaredfholgate) merged 15 commits into from
Aug 18, 2026
Merged

Implement Bicep module documentation generation #20183

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
e0ff9ef
Implement Bicep module documentation generation
jaredfholgate Aug 14, 2026
d1b796f
Make documentation write failures cross-platform
jaredfholgate Aug 14, 2026
2b1a183
Improve documentation generation robustness
jaredfholgate Aug 15, 2026
5e61796
Simplify documentation generation APIs
jaredfholgate Aug 15, 2026
73699d0
Clarify custom template value option
jaredfholgate Aug 15, 2026
d92ddae
Support custom template value files
jaredfholgate Aug 15, 2026
a5418c6
refactor(docs): reuse shared output infrastructure
jaredfholgate Aug 17, 2026
1a1bda3
test(docs): use platform-neutral absolute path
jaredfholgate Aug 17, 2026
4cfde8a
feat(docs): add configurable generation settings
jaredfholgate Aug 17, 2026
f3cc892
docs: expand experimental docs command reference
jaredfholgate Aug 17, 2026
789b91c
feat(docs): add conventional config discovery
jaredfholgate Aug 17, 2026
948798d
fix(docs): preserve root directory paths
jaredfholgate Aug 17, 2026
89cabfd
refactor(docs): align CLI and configuration
jaredfholgate Aug 18, 2026
583ede7
test(docs): cover exported discriminator projection
jaredfholgate Aug 18, 2026
0e179b3
docs: reference configuration inheritance REP
jaredfholgate Aug 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .gitattributes
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,7 @@
/src/Bicep.Core.Samples/Files/baselines/*_LF/**/*.bicep eol=lf
/src/Bicep.Core.Samples/Files/baselines/*_CRLF/**/*.bicep eol=crlf
/src/Bicep.Core.Samples/Files/baselines/*_CRLF/**/*.json text eol=crlf
/src/Bicep.RpcClient.Tests/Files/PublicApis/*.txt text eol=lf
/src/Bicep.RpcClient.Tests/Files/PublicApis/*.txt text eol=lf
/src/Bicep.Core.UnitTests/Files/Documentation/*.md text eol=lf
/src/Bicep.Cli.IntegrationTests/Files/DocsCommandTests/**/*.md text eol=lf
/.gitattributes whitespace=cr-at-eol
4 changes: 4 additions & 0 deletions docs/experimental-features.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,3 +125,7 @@ Command that allows the publishing of extensions to container registries. For mo
### Bicep MCP Server

See [Using Bicep MCP Server in VS Code (Preview!)](./experimental/mcp-tools.md).

### `docs` CLI Command

Generates module documentation. For command and template model details, see [Generate module documentation](./experimental/docs-commands.md).
Loading
Loading