docs: align all documentation to WARP-VSC style and template#2
Merged
Conversation
Rewrites the full documentation suite to match the clean, structured style used in the WARP-VSC (OzBridge) repository — removing decorative HTML elements and adopting consistent Markdown-only conventions. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR rewrites the repository’s documentation to match a consistent WARP-VSC-style Markdown template, removing decorative HTML and reorganizing content into clearer, structured sections.
Changes:
- Restructured
README.mdwith a new narrative intro, feature gallery, expanded TOC, installation/usage/configuration sections, architecture overview, troubleshooting, and FAQ. - Expanded and standardized policy/process docs (
SECURITY.md,CONTRIBUTING.md,.github/PULL_REQUEST_TEMPLATE.md) with new sections, checklists, and tables. - Normalized documentation formatting updates in
TESTING.mdandCHANGELOG.md.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
README.md |
Major restructure and new sections (installation/usage/config/architecture/troubleshooting/FAQ) to standardize documentation style. |
CONTRIBUTING.md |
Adds a structured contributor playbook, TOC, coding/testing standards, and reporting guidance. |
SECURITY.md |
Expands security policy with supported versions table, reporting process, scope, and disclosure policy. |
TESTING.md |
Adds structured prerequisites and converts the final checklist into Markdown checkboxes. |
CHANGELOG.md |
Updates intro wording and changes release header date separators to em-dash style. |
.github/PULL_REQUEST_TEMPLATE.md |
Restructures PR template into standardized sections with testing and checklist items. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Rename Feature gallery heading to avoid anchor collision with Configuration > Provider Routing section - Fix "behaviour" → "behavior" (US English consistency) - Correct SECURITY.md TLS bullet to reflect actual validator behavior (accepts https:// and http://, does not reject http) - Remove Dependabot claim — no dependabot.yml exists in the repo Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.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.
Summary
Rewrites the full documentation suite to match the clean, structured style used in the WARP-VSC (OzBridge) repository. Removes decorative HTML elements and adopts consistent Markdown-only conventions throughout.
Related Issue
N/A — documentation-only revision.
Type of Change
Changes Made
<div align="center">capsule-render banners,for-the-badgedark badges, and decorative footer; added flat standard badges, prose intro, Feature gallery section, nested TOC, Features as bullet list, Requirements section, Installation with three H3 sub-sections (Community hub / Manual / From source), Usage tables, Architecture table + folder tree, H3/H4 Troubleshooting (replaces<details>), and a FAQ section- YYYY-MM-DDto— YYYY-MM-DD(em-dash); intro line updated with project name in bold- [ ]Markdown checkboxesTesting
<div>,<details>,<summary>, capsule-render) remain in any.mdfiletests.yml)Checklist