Skip to content

Add documentation generation infrastructure#22

Merged
Malcolmnixon merged 6 commits intomainfrom
copilot/generate-documentation-structure
Mar 2, 2026
Merged

Add documentation generation infrastructure#22
Malcolmnixon merged 6 commits intomainfrom
copilot/generate-documentation-structure

Conversation

Copy link
Contributor

Copilot AI commented Mar 2, 2026

  • Create docs/template/template.html - standard pandoc HTML template
  • Create docs/guide/ folder with definition.yaml, guide.md, title.txt
  • Create docs/buildnotes/ folder with definition.yaml, introduction.md, title.txt
  • Create package.json with node dev-tools (mermaid-cli, mermaid-filter)
  • Update .config/dotnet-tools.json - add pandoctool, weasyprinttool, buildmark, versionmark
  • Update .gitignore - exclude only specific generated HTML files (buildnotes.html, guide.html) rather than all HTML under docs
  • Update .cspell.json - add pandoctool, weasyprinttool words
  • Update .github/workflows/build.yaml - build-docs runs on windows-latest, full section banners matching TemplateDotNetLibrary, actions/setup-node@v6 with lts/*, mermaid-filter.cmd, dedicated tool version capture step
  • Update .github/workflows/release.yaml - download documents artifact, use buildnotes.md as bodyFile
  • Create .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.

Copilot AI and others added 2 commits March 2, 2026 00:13
…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>
Copilot AI changed the title [WIP] Add documentation generation structure and tools Add documentation generation infrastructure Mar 2, 2026
… style

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
@Malcolmnixon
Copy link
Contributor

@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>
Copy link
Contributor Author

Copilot AI commented Mar 2, 2026

@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 t...

Added .versionmark.yaml in commit 6f7bc39 with entries for the tools specific to this project: dotnet, git, node, spdx-tool, vswhere, pandoc, weasyprint, buildmark, and versionmark.

@Malcolmnixon
Copy link
Contributor

@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>
Copy link
Contributor Author

Copilot AI commented Mar 2, 2026

@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/...

Fixed in commit 30fe28c. The build-docs job now:

  • Runs on windows-latest
  • Uses actions/setup-node@v6 with node-version: 'lts/*'
  • Has the full section banner structure (=== CHECKOUT AND DOWNLOAD ARTIFACTS ===, === INSTALL DEPENDENCIES ===, === CAPTURE TOOL VERSIONS ===, === GENERATE MARKDOWN REPORTS ===, === GENERATE HTML DOCUMENTS WITH PANDOC ===, === GENERATE PDF DOCUMENTS WITH WEASYPRINT ===, === UPLOAD ARTIFACTS ===) matching the TemplateDotNetLibrary style
  • Uses mermaid-filter.cmd (Windows path) for the Pandoc filter
  • Installs Node/npm before dotnet tools and captures node and npm versions

@Malcolmnixon Malcolmnixon marked this pull request as ready for review March 2, 2026 01:06
@Malcolmnixon Malcolmnixon merged commit 4ec7e78 into main Mar 2, 2026
4 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/generate-documentation-structure branch March 2, 2026 01:07
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.

2 participants