Skip to content

docs(readme): collapsible accordion sections for all 115 cartridges#86

Merged
hyperpolymath merged 2 commits into
mainfrom
docs/readme-accordion-scope
May 20, 2026
Merged

docs(readme): collapsible accordion sections for all 115 cartridges#86
hyperpolymath merged 2 commits into
mainfrom
docs/readme-accordion-scope

Conversation

@hyperpolymath

Copy link
Copy Markdown
Owner

Summary

Replace the brief 9-bullet Features list with a Scope section containing 14 collapsible (`

Details`) accordions, one per cartridge domain. Each accordion is a table of cartridges in that domain with one-line descriptions sourced from each cartridge's own `cartridge.json`.

Why

  • The project's main differentiator — "115 cartridges across every major DevOps + AI domain" — was getting compressed to a 9-line bullet list. Readers couldn't actually browse the surface area.
  • Glama, npm, GitHub, JSR all render `
    ` blocks as accordions out of the box. No platform-specific magic.
  • Cmd-F on the rendered page hits every cartridge name and description even when collapsed.

What's in the diff

  • Top section (badges, intro, install) unchanged.
  • New Scope section with 14 accordion categories:
    1. Git forges & code hosting (4)
    2. Cloud platforms (10)
    3. Databases (12)
    4. Containers, deploy & integrity (5)
    5. CI/CD & observability (8)
    6. Communications & messaging (6)
    7. Productivity & knowledge (10)
    8. ML, AI & coordination (8)
    9. Browser & web automation (2)
    10. Code intelligence & research (5)
    11. Developer tooling — LSP/DAP/BSP, languages, registries (14)
    12. Security & secrets (7)
    13. Infrastructure-as-code, config & proof (7)
    14. Hyperpolymath-native admin & ecosystem (13)
  • New Bridge-level tools (41 exposed) subsection — explains which cartridges have explicit `boj__` tools vs. which are reached via `boj_cartridge_invoke`.
  • `BOJ_TOOL_SCOPE` env var documented for narrowing the advertised tool surface.

Local-coord-mcp, Glama AAA posture, and License sections retained as-is.

What this doesn't change

  • The Glama-rendered Tools list at the top of the project page (its own widget driven by MCP `tools/list`) — that's a flat alphabetical list with no grouping you can control. The accordions help on the README portion below it.
  • No tool definitions, schemas, or runtime behavior changed. Docs-only.

Sequencing

This PR is independent of #84 (release/0.4.7) and #85 (Scorecard + CITATION.cff). If #84 merges first, this rebases trivially — the Install section it touches is at a different region than the accordions.

Test plan

  • GitHub renders accordions (collapsed by default, click-to-expand)
  • Cmd-F hits cartridge names even when accordions are closed (browser-dependent)
  • No CI regressions (docs-only)
  • Glama re-scan picks up the new README on next sync

🤖 Generated with Claude Code

Replace the brief Features bullet list with a Scope section containing
14 collapsible (<details>) accordions, one per cartridge domain. Each
accordion lists every cartridge in that domain with a one-line description
sourced from the cartridge's own cartridge.json.

Why
- "115 cartridges" was abstract; readers couldn't browse them
- The cartridge surface area is the project's main differentiator —
  it should be discoverable, not buried
- Accordions render correctly on GitHub, npm, Glama, JSR — no platform-
  specific magic; pure GitHub-flavored Markdown

What
- Top section (badges, intro, install) unchanged
- Scope section: 14 accordion categories covering all 115 cartridges
  + 1 self-health
- Each accordion: table of cartridges with description; bridge-level
  tool references where applicable
- New "Bridge-level tools (41 exposed)" section explaining which
  cartridges have explicit boj_<domain>_<verb> tools vs. which require
  boj_cartridge_invoke
- BOJ_TOOL_SCOPE env var documented for scope-narrowing

Local-coord-mcp, Glama AAA posture, and License sections retained
unchanged.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown

🔍 Hypatia Security Scan

Findings: 29 issues detected

Severity Count
🔴 Critical 18
🟠 High 4
🟡 Medium 7

⚠️ Action Required: Critical security issues found!

View findings
[
  {
    "reason": "Stale AI session file -- delete",
    "type": "stale",
    "file": "GEMINI.md",
    "action": "delete",
    "rule_module": "root_hygiene",
    "severity": "medium"
  },
  {
    "reason": "Issue in quality.yml",
    "type": "missing_workflow",
    "file": "quality.yml",
    "action": "create",
    "rule_module": "workflow_audit",
    "severity": "high"
  },
  {
    "reason": "Issue in security-policy.yml",
    "type": "missing_workflow",
    "file": "security-policy.yml",
    "action": "create",
    "rule_module": "workflow_audit",
    "severity": "medium"
  },
  {
    "reason": "Action hyperpolymath/standards/.github/workflows/governance-reusable.yml@main needs attention",
    "type": "unpinned_action",
    "file": "governance.yml",
    "action": "pin_sha",
    "rule_module": "workflow_audit",
    "severity": "high"
  },
  {
    "reason": "Python file detected -- banned language",
    "type": "banned_language_file",
    "file": "/home/runner/work/boj-server/boj-server/.github/scripts/validate-eclexiaiser.py",
    "action": "flag",
    "rule_module": "cicd_rules",
    "severity": "critical"
  },
  {
    "reason": "TypeScript file detected -- banned language",
    "type": "banned_language_file",
    "file": "/home/runner/work/boj-server/boj-server/cartridges/sanctify-mcp/adapter/mod.ts",
    "action": "flag",
    "rule_module": "cicd_rules",
    "severity": "critical"
  },
  {
    "reason": "TypeScript file detected -- banned language",
    "type": "banned_language_file",
    "file": "/home/runner/work/boj-server/boj-server/cartridges/academic-workflow-mcp/adapter/mod.ts",
    "action": "flag",
    "rule_module": "cicd_rules",
    "severity": "critical"
  },
  {
    "reason": "TypeScript file detected -- banned language",
    "type": "banned_language_file",
    "file": "/home/runner/work/boj-server/boj-server/cartridges/fireflag-mcp/adapter/mod.ts",
    "action": "flag",
    "rule_module": "cicd_rules",
    "severity": "critical"
  },
  {
    "reason": "TypeScript file detected -- banned language",
    "type": "banned_language_file",
    "file": "/home/runner/work/boj-server/boj-server/cartridges/ephapax-mcp/adapter/mod.ts",
    "action": "flag",
    "rule_module": "cicd_rules",
    "severity": "critical"
  },
  {
    "reason": "TypeScript file detected -- banned language",
    "type": "banned_language_file",
    "file": "/home/runner/work/boj-server/boj-server/cartridges/bofig-mcp/adapter/mod.ts",
    "action": "flag",
    "rule_module": "cicd_rules",
    "severity": "critical"
  }
]

Powered by Hypatia Neurosymbolic CI/CD Intelligence

@hyperpolymath
hyperpolymath merged commit 76e15b1 into main May 20, 2026
13 of 16 checks passed
@hyperpolymath
hyperpolymath deleted the docs/readme-accordion-scope branch May 20, 2026 06:14
@github-actions

Copy link
Copy Markdown

🔍 Hypatia Security Scan

Findings: 29 issues detected

Severity Count
🔴 Critical 18
🟠 High 4
🟡 Medium 7

⚠️ Action Required: Critical security issues found!

View findings
[
  {
    "reason": "Stale AI session file -- delete",
    "type": "stale",
    "file": "GEMINI.md",
    "action": "delete",
    "rule_module": "root_hygiene",
    "severity": "medium"
  },
  {
    "reason": "Issue in quality.yml",
    "type": "missing_workflow",
    "file": "quality.yml",
    "action": "create",
    "rule_module": "workflow_audit",
    "severity": "high"
  },
  {
    "reason": "Issue in security-policy.yml",
    "type": "missing_workflow",
    "file": "security-policy.yml",
    "action": "create",
    "rule_module": "workflow_audit",
    "severity": "medium"
  },
  {
    "reason": "Action hyperpolymath/standards/.github/workflows/governance-reusable.yml@main needs attention",
    "type": "unpinned_action",
    "file": "governance.yml",
    "action": "pin_sha",
    "rule_module": "workflow_audit",
    "severity": "high"
  },
  {
    "reason": "Python file detected -- banned language",
    "type": "banned_language_file",
    "file": "/home/runner/work/boj-server/boj-server/.github/scripts/validate-eclexiaiser.py",
    "action": "flag",
    "rule_module": "cicd_rules",
    "severity": "critical"
  },
  {
    "reason": "TypeScript file detected -- banned language",
    "type": "banned_language_file",
    "file": "/home/runner/work/boj-server/boj-server/cartridges/sanctify-mcp/adapter/mod.ts",
    "action": "flag",
    "rule_module": "cicd_rules",
    "severity": "critical"
  },
  {
    "reason": "TypeScript file detected -- banned language",
    "type": "banned_language_file",
    "file": "/home/runner/work/boj-server/boj-server/cartridges/academic-workflow-mcp/adapter/mod.ts",
    "action": "flag",
    "rule_module": "cicd_rules",
    "severity": "critical"
  },
  {
    "reason": "TypeScript file detected -- banned language",
    "type": "banned_language_file",
    "file": "/home/runner/work/boj-server/boj-server/cartridges/fireflag-mcp/adapter/mod.ts",
    "action": "flag",
    "rule_module": "cicd_rules",
    "severity": "critical"
  },
  {
    "reason": "TypeScript file detected -- banned language",
    "type": "banned_language_file",
    "file": "/home/runner/work/boj-server/boj-server/cartridges/ephapax-mcp/adapter/mod.ts",
    "action": "flag",
    "rule_module": "cicd_rules",
    "severity": "critical"
  },
  {
    "reason": "TypeScript file detected -- banned language",
    "type": "banned_language_file",
    "file": "/home/runner/work/boj-server/boj-server/cartridges/bofig-mcp/adapter/mod.ts",
    "action": "flag",
    "rule_module": "cicd_rules",
    "severity": "critical"
  }
]

Powered by Hypatia Neurosymbolic CI/CD Intelligence

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.

1 participant