Refocus README + unify documentation polish with Hack23 ecosystem SEO#2072
Refocus README + unify documentation polish with Hack23 ecosystem SEO#2072
Conversation
…cy, democracy & AI-generated news Agent-Logs-Url: https://github.com/Hack23/riksdagsmonitor/sessions/0778e8dd-4b6f-45ce-a250-7ac12712a4ec Co-authored-by: pethers <1726836+pethers@users.noreply.github.com>
Agent-Logs-Url: https://github.com/Hack23/riksdagsmonitor/sessions/0778e8dd-4b6f-45ce-a250-7ac12712a4ec Co-authored-by: pethers <1726836+pethers@users.noreply.github.com>
…y docs Agent-Logs-Url: https://github.com/Hack23/riksdagsmonitor/sessions/cc4d9450-abd4-4df8-9e32-7f9c7e9a21c1 Co-authored-by: pethers <1726836+pethers@users.noreply.github.com>
…o docs (19 more) Agent-Logs-Url: https://github.com/Hack23/riksdagsmonitor/sessions/fcf6fb5d-0c80-41e1-861b-641bf0b566ce Co-authored-by: pethers <1726836+pethers@users.noreply.github.com>
🏷️ Automatic Labeling SummaryThis PR has been automatically labeled based on the files changed and PR metadata. Applied Labels: documentation,security,i18n,translation,isms,iso-27001,nist-csf,cis-controls,skill,size-xl,agent Label Categories
For more information, see |
🔍 Lighthouse Performance Audit
📥 Download full Lighthouse report Budget Compliance: Performance budgets enforced via |
🔍 Lighthouse Performance Audit
📥 Download full Lighthouse report Budget Compliance: Performance budgets enforced via |
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
This PR standardizes the repository’s root documentation presentation and improves cross-linking for ecosystem SEO, while refocusing the root README around platform discoverability and autonomous newsroom capabilities.
Changes:
- Refactors
README.mdto a shorter, more platform-focused structure with updated links, metrics, and navigation. - Introduces consistent “centered-banner” headers for several previously plain docs.
- Appends a unified “Hack23 Ecosystem” footer across root documentation files.
Reviewed changes
Copilot reviewed 32 out of 33 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| WORKFLOWS.md | Appends standardized Hack23 Ecosystem footer for cross-linking/SEO consistency. |
| TRANSLATION_GUIDE.md | Adds centered-banner header and appends Hack23 Ecosystem footer. |
| THREAT_MODEL.md | Appends standardized Hack23 Ecosystem footer. |
| TESTING.md | Adds centered-banner header and appends Hack23 Ecosystem footer. |
| SWOT.md | Appends standardized Hack23 Ecosystem footer. |
| STATEDIAGRAM.md | Appends standardized Hack23 Ecosystem footer. |
| SKILLS.md | Adds centered-banner header and appends Hack23 Ecosystem footer. |
| SECURITY_ARCHITECTURE.md | Appends standardized Hack23 Ecosystem footer. |
| SECURITY.md | Appends standardized Hack23 Ecosystem footer. |
| RELEASE_PROCESS.md | Adds centered-banner header and appends Hack23 Ecosystem footer. |
| README.md | Refocuses README structure/content and updates key links and platform navigation. |
| MINDMAP.md | Appends standardized Hack23 Ecosystem footer. |
| LABELS.md | Adds centered-banner header and appends Hack23 Ecosystem footer. |
| FinancialSecurityPlan.md | Appends standardized Hack23 Ecosystem footer. |
| FUTURE_WORKFLOWS.md | Appends standardized Hack23 Ecosystem footer. |
| FUTURE_THREAT_MODEL.md | Appends standardized Hack23 Ecosystem footer. |
| FUTURE_SWOT.md | Appends standardized Hack23 Ecosystem footer. |
| FUTURE_STATEDIAGRAM.md | Appends standardized Hack23 Ecosystem footer. |
| FUTURE_SECURITY_ARCHITECTURE.md | Appends standardized Hack23 Ecosystem footer. |
| FUTURE_MINDMAP.md | Appends standardized Hack23 Ecosystem footer. |
| FUTURE_FLOWCHART.md | Appends standardized Hack23 Ecosystem footer. |
| FUTURE_DATA_MODEL.md | Appends standardized Hack23 Ecosystem footer. |
| FUTURE_ARCHITECTURE.md | Appends standardized Hack23 Ecosystem footer. |
| FLOWCHART.md | Appends standardized Hack23 Ecosystem footer. |
| End-of-Life-Strategy.md | Appends standardized Hack23 Ecosystem footer. |
| DATA_MODEL.md | Appends standardized Hack23 Ecosystem footer. |
| CRA-ASSESSMENT.md | Appends standardized Hack23 Ecosystem footer. |
| CONTRIBUTING.md | Appends standardized Hack23 Ecosystem footer. |
| CODE_OF_CONDUCT.md | Appends standardized Hack23 Ecosystem footer. |
| BCPPlan.md | Appends standardized Hack23 Ecosystem footer. |
| Article-Generation.md | Appends standardized Hack23 Ecosystem footer. |
| ARCHITECTURE.md | Appends standardized Hack23 Ecosystem footer. |
| AGENTS.md | Adds centered-banner header and appends Hack23 Ecosystem footer. |
Comments suppressed due to low confidence (2)
TRANSLATION_GUIDE.md:1
- Org.nr formatting is inconsistent across the repo/docs (sometimes
5595347807, sometimes559534-7807). For legal identifiers, it’s best to standardize on one canonical representation across all documents (including headers and footers) to avoid ambiguity and accidental drift.
WORKFLOWS.md:1 - The ecosystem footer appears to be copy-pasted verbatim across many root docs. That makes future updates (URLs, badges, policy links, org metadata) error-prone and increases the risk of docs drifting out of sync. Consider introducing a single source-of-truth template (e.g.,
docs/_fragments/hack23-ecosystem-footer.md) plus a small sync script and/or CI check that enforces identical footer content across files; this preserves the SEO benefit while keeping edits centralized.
| ## 🌐 Explore the Platform | ||
|
|
||
| ### 📋 Data Classification Levels | ||
| Four flagship pages anchor the public site. Each is **multilingual (14 languages)**, **WCAG 2.1 AA accessible**, **SEO-optimised** with JSON-LD structured data and `hreflang` alternates, and **CSP-hardened** with Subresource Integrity (SRI) on every CDN asset. | ||
|
|
||
| For operational data handling, we use a simplified 4-level scheme: | ||
| <table> | ||
| <thead> | ||
| <tr><th width="80" align="center">Icon</th><th>Page</th><th>What it does</th></tr> | ||
| </thead> | ||
| <tbody> |
There was a problem hiding this comment.
This section says “Four flagship pages” but the table that follows includes more than four entries (e.g., it also lists a Sitemap). Please align the prose with the actual number of rows (update the count, or remove/relocate the extra row) to avoid confusing readers.
| <a href="#"><img src="https://img.shields.io/badge/Owner-CEO-0A66C2?style=for-the-badge" alt="Owner"/></a> | ||
| <a href="#"><img src="https://img.shields.io/badge/Version-1.0-555?style=for-the-badge" alt="Version"/></a> | ||
| <a href="#"><img src="https://img.shields.io/badge/Coverage-70%25_lines-brightgreen?style=for-the-badge" alt="Coverage"/></a> | ||
| <a href="#"><img src="https://img.shields.io/badge/WCAG-2.1_AA-purple?style=for-the-badge" alt="WCAG 2.1 AA"/></a> |
There was a problem hiding this comment.
The badges are wrapped in links with href=\"#\", which creates non-functional links and can be confusing for keyboard users and automated link checking. Prefer either (a) removing the surrounding <a> entirely if the badge isn’t meant to link anywhere, or (b) linking to a real target (e.g., an internal anchor/section, a policy document, or a GitHub profile/org page).
| <a href="#"><img src="https://img.shields.io/badge/Owner-CEO-0A66C2?style=for-the-badge" alt="Owner"/></a> | |
| <a href="#"><img src="https://img.shields.io/badge/Version-1.0-555?style=for-the-badge" alt="Version"/></a> | |
| <a href="#"><img src="https://img.shields.io/badge/Coverage-70%25_lines-brightgreen?style=for-the-badge" alt="Coverage"/></a> | |
| <a href="#"><img src="https://img.shields.io/badge/WCAG-2.1_AA-purple?style=for-the-badge" alt="WCAG 2.1 AA"/></a> | |
| <img src="https://img.shields.io/badge/Owner-CEO-0A66C2?style=for-the-badge" alt="Owner"/> | |
| <img src="https://img.shields.io/badge/Version-1.0-555?style=for-the-badge" alt="Version"/> | |
| <img src="https://img.shields.io/badge/Coverage-70%25_lines-brightgreen?style=for-the-badge" alt="Coverage"/> | |
| <img src="https://img.shields.io/badge/WCAG-2.1_AA-purple?style=for-the-badge" alt="WCAG 2.1 AA"/> |
|
@copilot apply changes based on the comments in this thread |
…f=# badge wrappers Agent-Logs-Url: https://github.com/Hack23/riksdagsmonitor/sessions/a92d981c-cf1f-4272-afc5-2dbc22d2b4a3 Co-authored-by: pethers <1726836+pethers@users.noreply.github.com>
Both reviewer points addressed in 17e0aca:
|
🔍 Lighthouse Performance Audit
📥 Download full Lighthouse report Budget Compliance: Performance budgets enforced via |
Plan: README rewrite + complete documentation polish & Hack23 ecosystem SEO
Phase 1 — README rewrite (✅ done)
Phase 2 — Documentation polish (✅ done)
🔗 Hack23 Ecosystemfooter added to 13 most important docsPhase 3 — Extend SEO footer to entire portfolio (✅ done)
Phase 4 — Address PR review comments (✅ done)
<a href="#">wrappers around decorative shields.io badges (per @copilot-pull-request-reviewer feedback onTESTING.md:13-16— applies repo-wide for keyboard-user accessibility and link-checker hygiene)Final result