Skip to content

Update PDF document names and template file#70

Merged
Malcolmnixon merged 4 commits intomainfrom
copilot/update-pdf-document-names
Jan 11, 2026
Merged

Update PDF document names and template file#70
Malcolmnixon merged 4 commits intomainfrom
copilot/update-pdf-document-names

Conversation

Copy link
Contributor

Copilot AI commented Jan 11, 2026

PDF documents generated by the build pipeline had generic names (guide.pdf, requirements.pdf, tracematrix.pdf) that don't convey context after download.

Changes

  • PDF output paths in .github/workflows/build.yaml:

    • docs/guide.pdfdocs/ReqStream User Guide.pdf
    • docs/requirements.pdfdocs/ReqStream Requirements.pdf
    • docs/tracematrix.pdfdocs/ReqStream Trace Matrix.pdf
  • Template file renamed from guide_template.html to template.html:

    • The template is used for all three document types, not just the guide
    • Updated references in docs/{guide,requirements,tracematrix}/definition.yaml
Original prompt

This section details on the original issue you should resolve

<issue_title>[Feature]: Update PDF Document Names</issue_title>
<issue_description>### Problem Statement

The PDF document names should be updated so that they make sense after downloading.

Proposed Solution

"guide.pdf" should probably be renamed to "ReqStream User Guide.pdf"
"requirements.pdf" should probably be renamed to "ReqStream Requirements.pdf"
"tracematrix.pdf" should probably be renamed to "ReqStream Trace Matrix.pdf"

Alternatives Considered

No response

Additional Context

No response

Priority

None

Contribution

  • I would be willing to submit a PR for this feature

Code of Conduct

  • I agree to follow this project's Code of Conduct</issue_description>

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


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 3 commits January 11, 2026 23:39
- Rename guide_template.html to template.html since it's used for all documents
- Update PDF output names to include "ReqStream" prefix and be more descriptive
- Update all definition.yaml files to reference the renamed template

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Changed artifact path back to wildcard pattern (docs/*.pdf) for flexibility in case more PDFs are added in the future. GitHub Actions handles filenames with spaces correctly.

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI changed the title [WIP] Update PDF document names for clarity Update PDF document names and template file Jan 11, 2026
Copilot AI requested a review from Malcolmnixon January 11, 2026 23:43
@Malcolmnixon Malcolmnixon marked this pull request as ready for review January 11, 2026 23:46
@Malcolmnixon Malcolmnixon merged commit 0580cca into main Jan 11, 2026
13 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/update-pdf-document-names branch January 11, 2026 23:49
Copilot AI added a commit that referenced this pull request Mar 26, 2026
Apply all missing changes from the TemplateDotNetTool template to bring
ReqStream into consistency with the latest template patterns.

Changes applied from PRs #58-#74:

PR #58 (ReviewMark integration):
- Add .reviewmark.yaml with ReqStream-specific review sets
- Add pip-requirements.txt (yamllint==1.38.0)
- Update lint.sh/lint.bat to use Python venv + pip pattern
- Update package.json with pinned cspell and markdownlint-cli2 devDependencies
- Add demaconsulting.reviewmark to .config/dotnet-tools.json
- Add reviewmark entry to .versionmark.yaml

PR #59 (Add Code Review Agent to AGENTS.md invocation rules):
- Add code-review agent to AGENTS.md available agents list
- Add new .github/agents/code-review.agent.md

PR #61 (Linting modernization and agent file standardization):
- Update .markdownlint-cli2.yaml with PURPOSE/DO NOT MODIFY header
- Update .yamllint.yaml with PURPOSE/DO NOT MODIFY header
- Remove check-keys from yamllint truthy rule (aligns with template)

PR #63 (enforce cspell word list policy):
- Update .cspell.yaml header comment (NEVER add misspelled word)
- Add missing technical terms to cspell word list (reviewmark, ReviewMark,
  versionmark, VersionMark, buildmark, BuildMark, gitattributes, etc.)

PR #64 (Align lint YAML configs):
- Apply standardized headers to markdownlint and yamllint configs

PR #65-#67, #70-#73 (Agent synchronization):
- Update code-quality.agent.md to template version (comprehensive content)
- Update agent frontmatter descriptions to match shorter template pattern
- Update repo-consistency agent and requirements, software-developer,
  technical-writer, test-developer agents

PR #71 (.gitattributes LF line endings):
- .gitattributes already had correct content

PR #72 (Simplify repo-consistency agent):
- repo-consistency.agent.md already aligned

PR #54 (Various improvements):
- Update .versionmark.yaml regex patterns to support pre-release versions
- Update .gitignore to match template structure

CONTRIBUTING.md:
- Rewrite to match template standards with ReqStream-specific translation
- Add dotnet tool restore step, XML documentation section
- Add comprehensive testing guidelines with MSTest v4 assertions
- Add requirements management section
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.

[Feature]: Update PDF Document Names

2 participants