Skip to content

Refresh and consolidate project documentation - #4

Merged
mgradwohl merged 2 commits into
mainfrom
mgradwohl-refresh-documentation
Aug 19, 2026
Merged

mgradwohl merged 2 commits into
mainfrom
mgradwohl-refresh-documentation

Conversation

@mgradwohl

Copy link
Copy Markdown
Owner

Description

The repository documentation had drifted from the current C++ template and repeated the same setup, tooling, and design guidance across several files. This refresh makes the README the user-facing source of truth, narrows the contributor and security guides to their intended audiences, and reduces the backlog to work that is not yet implemented.

It also clarifies that the project currently exposes no reusable library API: Markdown remains the documentation priority, while future public C++ headers should use Doxygen-compatible comments rather than JSDoc or docstrings.

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update
  • Build/CI improvement

Checklist

  • I have read the contribution guidelines
  • My code follows the project's coding standards
  • I have run clang-format on my changes
  • I have run clang-tidy and addressed any warnings
  • I have added tests that prove my fix/feature works
  • All new and existing tests pass
  • I have updated documentation as needed

Testing

git diff --check
cmake --list-presets
# Verified that all local Markdown links resolve.

Additional Notes

clang-format, clang-tidy, and application tests are not applicable because this change only updates Markdown files. No inline C++ comments were added.

Align the Markdown documentation with the current C++ template, consolidate duplicated guidance, and clarify the policy for future public API documentation.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot AI lite review requested due to automatic review settings August 19, 2026 23:14

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request refreshes and consolidates repository documentation so that README.md is the primary user-facing reference, while CONTRIBUTING.md, SECURITY.md, TODO.md, and the PR template focus on their intended scopes.

Changes:

  • Restructures README.md into a concise command/workflow reference (presets, options, packaging, CI, dependencies, documentation conventions).
  • Narrows CONTRIBUTING.md and SECURITY.md to contributor workflow/coding conventions and vulnerability reporting/tooling expectations.
  • Replaces the long-form TODO list with a scoped backlog table and trims Copilot agent instructions to avoid duplication.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
TODO.md Replaces the previous long-form list with a focused backlog split into near-term, future, and deferred items.
SECURITY.md Updates supported-version guidance and consolidates vulnerability reporting expectations plus security-relevant tooling notes.
README.md Becomes the central reference for setup, requirements, presets, dev commands, options, packaging, CI, dependencies, and documentation guidance.
CONTRIBUTING.md Refocuses on toolchain validation, preset-based workflow, C++ conventions, tests, and documentation responsibilities.
.github/pull_request_template.md Updates the checklist link wording/target for contribution guidelines.
.github/copilot-instructions.md Removes duplicated documentation and keeps only agent-specific working practices, validation, and style constraints.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread README.md Resolved
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@mgradwohl
mgradwohl merged commit 6ac4157 into main Aug 19, 2026
1 check passed
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