Repository navigation
Refresh and consolidate project documentation - #4
Merged
Merged
Conversation
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>
Contributor
There was a problem hiding this comment.
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.mdinto a concise command/workflow reference (presets, options, packaging, CI, dependencies, documentation conventions). - Narrows
CONTRIBUTING.mdandSECURITY.mdto 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.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
Checklist
clang-formaton my changesclang-tidyand addressed any warningsTesting
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.