Add missing ISMS artifacts and standardize document style#370
Conversation
…DUCT.md, FLOWCHART.md, FUTURE_STATEDIAGRAM.md, FUTURE_MINDMAP.md, FUTURE_SWOT.md Co-authored-by: pethers <[email protected]>
…hitecture documentation portfolio Co-authored-by: pethers <[email protected]>
🔍 Lighthouse Performance Audit
📥 Download full Lighthouse report Budget Compliance: Performance budgets enforced via |
There was a problem hiding this comment.
Pull request overview
Adds the remaining Hack23 ISMS/governance artifacts and expands the architecture documentation portfolio, while updating existing documentation to follow the standardized Hack23 document layout.
Changes:
- Adds new governance docs (
SECURITY.md,CONTRIBUTING.md,CODE_OF_CONDUCT.md) and missing architecture artifacts (FLOWCHART.md,FUTURE_STATEDIAGRAM.md,FUTURE_MINDMAP.md,FUTURE_SWOT.md). - Updates
MINDMAP.mdto the standardized Hack23 document format and cross-links the portfolio. - Updates
README.mdto include an architecture documentation portfolio table and links to the new governance docs.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| SECURITY.md | Introduces security policy and vulnerability reporting process with ISMS policy links. |
| CONTRIBUTING.md | Adds contribution guidance and quality gates aligned with repo tooling/ISMS. |
| CODE_OF_CONDUCT.md | Adds community governance document. |
| README.md | Adds portfolio table + links to governance/security documentation. |
| MINDMAP.md | Migrates to standardized Hack23 doc format and updates related-links/footer. |
| FLOWCHART.md | Adds Mermaid flowcharts for CI/CD, news generation, CIA pipeline, user journey, etc. |
| FUTURE_STATEDIAGRAM.md | Adds future-state Mermaid state diagrams for planned capabilities. |
| FUTURE_MINDMAP.md | Adds future capability mindmaps and roadmap/timeline diagrams. |
| FUTURE_SWOT.md | Adds forward-looking SWOT with Mermaid quadrant chart and action matrix. |
| 4. Create a new branch: `git checkout -b my-branch-name` | ||
| 5. Make your change, add tests, and make sure the tests still pass. | ||
| 6. Validate HTML: `npx htmlhint *.html` | ||
| 7. Push to your fork and [submit a pull request][pr]. | ||
| 8. Pat yourself on the back and wait for your pull request to be reviewed and merged. |
There was a problem hiding this comment.
The HTML validation step suggests npx htmlhint *.html, but this repo already defines an htmlhint script that also lints news/*.html when present. To keep contributor guidance accurate and consistent with CI, point contributors to npm run htmlhint (or npm run validate-all / npm run validate-all && npm run test depending on intent).
There was a problem hiding this comment.
Fixed in 2101a10 — changed to npm run htmlhint which also lints news/*.html files.
README.md
Outdated
| - [AGENTS.md](AGENTS.md) - Custom Copilot agents for specialized tasks (13 agents) | ||
| - [SKILLS.md](SKILLS.md) - Agent skills for strategic guidance (56 skills) ✨ **UPDATED 2026-02-11** |
There was a problem hiding this comment.
README lists “13 agents” and “56 skills” here, but the repository currently contains 14 agents under .github/agents/ and 87 skills per SKILLS.md. Update the counts (and the “Available Agents/Skills” headings below) or remove the hard-coded numbers to avoid docs drifting out of sync.
There was a problem hiding this comment.
Fixed in 2101a10 — updated to 14 agents (added missing news-journalist) and 87 skills. Also removed stale ✨ NEW / ⬆️ markers.
| | Document | Focus | Description | | ||
| |----------|-------|-------------| | ||
| | **[SWOT](SWOT.md)** | 💼 Current | Current strategic analysis | | ||
| | **[Future Architecture](FUTURE_ARCHITECTURE.md)** | 🏗️ Future | System evolution roadmap | | ||
| | **[Future Mindmap](FUTURE_MINDMAP.md)** | 🗺️ Future | Future capability map | | ||
|
|
There was a problem hiding this comment.
This table is written with || (double pipe) row prefixes, which typically renders as an extra empty column. Use single | row prefixes (and a matching separator row) for proper Markdown table formatting, and apply consistently across tables in this document.
There was a problem hiding this comment.
Verified — this table already uses single | delimiters. The rendered output confirms correct formatting.
| | Document | Focus | Description | | ||
| |----------|-------|-------------| | ||
| | **[State Diagrams](STATEDIAGRAM.md)** | 🔄 Current | Current system state transitions | | ||
| | **[Future Architecture](FUTURE_ARCHITECTURE.md)** | 🏗️ Future | System evolution roadmap | | ||
| | **[Future Flowcharts](FUTURE_FLOWCHART.md)** | 🔄 Future | Advanced process flows | | ||
| | **[Future Data Model](FUTURE_DATA_MODEL.md)** | 📊 Future | Enhanced data architecture | | ||
| | **[Future Security](FUTURE_SECURITY_ARCHITECTURE.md)** | 🛡️ Future | Security roadmap | | ||
|
|
There was a problem hiding this comment.
The related-docs table uses || at the start of each row, which renders as an extra empty column in Markdown. Switch to single | delimiters and update the separator row; then apply the same correction to any other tables in this file.
There was a problem hiding this comment.
Verified — this table already uses single | delimiters. No || present in the source.
| | Document | Focus | Description | | ||
| |----------|-------|-------------| | ||
| | **[Mindmap](MINDMAP.md)** | 🗺️ Current | Current system conceptual map | | ||
| | **[Future Architecture](FUTURE_ARCHITECTURE.md)** | 🏗️ Future | System evolution roadmap | | ||
| | **[Future Flowcharts](FUTURE_FLOWCHART.md)** | 🔄 Future | Advanced process flows | | ||
| | **[Future SWOT](FUTURE_SWOT.md)** | 💼 Future | Strategic outlook | | ||
|
|
There was a problem hiding this comment.
This related-docs table starts rows with ||, which creates an unintended blank column in Markdown rendering. Replace the leading || with | (and fix the separator row) and apply consistently to the other tables in this document.
There was a problem hiding this comment.
Verified — this table already uses single | delimiters. No || present in the source.
| | Document | Focus | Description | | ||
| |----------|-------|-------------| | ||
| | **[Architecture](ARCHITECTURE.md)** | 🏛️ C4 Models | System structure and components | | ||
| | **[Data Model](DATA_MODEL.md)** | 📊 Data | Entities, schemas, relationships | | ||
| | **[State Diagrams](STATEDIAGRAM.md)** | 🔄 Behavior | System state transitions | | ||
| | **[Workflows](WORKFLOWS.md)** | 🔧 DevOps | CI/CD pipeline documentation | | ||
| | **[Security Architecture](SECURITY_ARCHITECTURE.md)** | 🛡️ Security | Defense-in-depth controls | | ||
| | **[Threat Model](THREAT_MODEL.md)** | 🎯 Threats | STRIDE analysis | | ||
| | **[Future Flowcharts](FUTURE_FLOWCHART.md)** | 🚀 Future | Advanced process flows roadmap | |
There was a problem hiding this comment.
The “Related Architecture Documentation” table uses || row prefixes, which typically renders as an extra empty column. Use single | delimiters and update the separator row, and apply the same correction to other tables in this file (e.g., the process inventory).
There was a problem hiding this comment.
Verified — this table already uses single | delimiters. No || present in the source.
| | Version | Supported | ISMS Policy | | ||
| | ------- | ------------------ | ----------- | | ||
| | latest | :white_check_mark: | [Vulnerability Management](https://github.com/Hack23/ISMS-PUBLIC/blob/main/Vulnerability_Management.md) | | ||
|
|
There was a problem hiding this comment.
The Markdown table here starts each row with || (double pipe), which renders as an extra empty column in most Markdown renderers. Replace the leading || with | (and update the header separator row accordingly) for correct table formatting (and apply consistently to other tables in this document).
There was a problem hiding this comment.
Verified — this table already uses single | delimiters. No || present in the source.
| | Document | Focus | Description | | ||
| |----------|-------|-------------| | ||
| | **[Architecture](ARCHITECTURE.md)** | 🏛️ C4 Models | System structure and components | | ||
| | **[Data Model](DATA_MODEL.md)** | 📊 Data | Entities, schemas, relationships | | ||
| | **[State Diagrams](STATEDIAGRAM.md)** | 🔄 Behavior | System state transitions | | ||
| | **[Flowcharts](FLOWCHART.md)** | 🔄 Processes | Process flows and pipelines | | ||
| | **[SWOT](SWOT.md)** | 💼 Strategy | Strategic position assessment | | ||
| | **[Future Mindmap](FUTURE_MINDMAP.md)** | 🚀 Future | Future capability map | |
There was a problem hiding this comment.
The “Related Architecture Documentation” table uses || at the start of each row, which introduces an unintended empty column in Markdown rendering. Change the row prefixes to single | and ensure the separator row matches, and apply the same fix to other tables in this file if present.
There was a problem hiding this comment.
Verified — this table already uses single | delimiters. No || present in the source.
| | Directory | Purpose | | ||
| |-----------|---------| | ||
| | `*.html` | Multi-language index pages (14 languages) | | ||
| | `styles.css` | Cyberpunk theme design system | | ||
| | `js/` | Dashboard JavaScript modules (Chart.js, D3.js) | | ||
| | `dashboard/` | Interactive intelligence dashboards | | ||
| | `news/` | Generated political news articles | | ||
| | `scripts/` | Build, generation, and utility scripts | | ||
| | `tests/` | Vitest unit tests | | ||
| | `cypress/` | Cypress E2E tests | | ||
| | `cia-data/` | CIA platform data exports | | ||
|
|
There was a problem hiding this comment.
The project structure table uses || at the beginning of each row, which introduces an extra empty column in rendered Markdown. Switch to single | delimiters (and matching separator row), and apply the same fix to other tables in this document (e.g., Quality Gates).
There was a problem hiding this comment.
Verified — both the Project Structure and Quality Gates tables already use single | delimiters. No || present.
|
@copilot apply changes based on the comments in this thread |
… missing news-journalist agent Co-authored-by: pethers <[email protected]>
Applied the valid changes in 2101a10:
The |
🔍 Lighthouse Performance Audit
📥 Download full Lighthouse report Budget Compliance: Performance budgets enforced via |
npx htmlhint *.htmltonpm run htmlhintfor CI consistency|formatting (reviewer||comments were false positives)💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.