Add documentation generation infrastructure#22
Conversation
…cs workflow job Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
…der docs Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
… style Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
|
@copilot Looks like you need to copy over the .versionmark.yaml file from https://github.com/demaconsulting/TemplateDotNetLibrary/blob/main/.versionmark.yaml but customized for the tools this project uses. |
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Added |
|
@copilot I think you may have messed up the build-docs job - it HAS to run under Windows for the DemaConsulting.WeasyPrint - make sure you follow the steps from https://github.com/demaconsulting/TemplateDotNetLibrary/blob/main/.github/workflows/build.yaml more closely - the OS, the shell. The only thing that should differ is the set of documents because this project doesn't have requirements or code-quality yet. |
… and mermaid-filter.cmd Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Fixed in commit 30fe28c. The
|
docs/template/template.html- standard pandoc HTML templatedocs/guide/folder withdefinition.yaml,guide.md,title.txtdocs/buildnotes/folder withdefinition.yaml,introduction.md,title.txtpackage.jsonwith node dev-tools (mermaid-cli, mermaid-filter).config/dotnet-tools.json- addpandoctool,weasyprinttool,buildmark,versionmark.gitignore- exclude only specific generated HTML files (buildnotes.html,guide.html) rather than all HTML under docs.cspell.json- addpandoctool,weasyprinttoolwords.github/workflows/build.yaml-build-docsruns onwindows-latest, full section banners matching TemplateDotNetLibrary,actions/setup-node@v6withlts/*,mermaid-filter.cmd, dedicated tool version capture step.github/workflows/release.yaml- download documents artifact, usebuildnotes.mdasbodyFile.versionmark.yaml- customized for project tools (dotnet, git, node, npm, spdx-tool, vswhere, pandoc, weasyprint, buildmark, versionmark)✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.