Skip to content

docs: enterprise-grade README, remove legacy README copy#11

Open
Patternslab-ecosystem wants to merge 1 commit intomainfrom
claude/docs-readme-enterprise
Open

docs: enterprise-grade README, remove legacy README copy#11
Patternslab-ecosystem wants to merge 1 commit intomainfrom
claude/docs-readme-enterprise

Conversation

@Patternslab-ecosystem
Copy link
Owner

What

  • Replace README.md with full enterprise-grade documentation:
    • Monorepo structure with all packages listed
    • Behavioral engine layers (L0–L6) table
    • Complete ADR table (ADR-001 through ADR-256, including ADR-007/008/009)
    • CI/CD quality gate table (S11 sentinel, lint, typecheck, coverage, Trivy, SBOM, Release Please, PII scan)
    • Benchmark 2030 metrics table with current status
    • Compliance table (EU AI Act, GDPR, S11, SBOM)
    • Governance Directives table (D-001 through D-005)
    • Contributing guide with branch naming, commit format, PR body requirements
    • Dev reference commands
    • Related repositories table
  • Remove README .md (filename with space) — legacy artifact causing confusion

Why

  • GitHub Org Enterprise Makeover — Faza F
  • Old README missing: governance directives, ADR-007/008/009, full CI gate table, SilenceEventV2 migration note, stack frozen policy
  • Public repo is now the face of the platform — needs professional documentation

DIR reference

  • Faza F — CORE enterprise-grade README

Testing

  • All badge URLs point to valid targets
  • ADR links match existing docs/ filenames
  • S11 compliant — no forbidden behavioral terms
  • No secrets, no PII
  • No regressions — README.md only, no code changes

## What
- Replace README.md with enterprise-grade documentation covering:
  monorepo structure, behavioral engine layers (L0-L6), full ADR table,
  CI/CD quality gate table, Benchmark 2030 metrics, compliance table,
  governance directives, contributing guide, dev reference
- Remove 'README .md' (filename with space) — legacy artifact

## Why
- GitHub Org Enterprise Makeover — Faza F: CORE enterprise-grade README
- Old README lacked: governance directives, ADR-007/008/009, full CI table,
  SilenceEventV2 migration note, stack frozen details
- Legacy 'README .md' causes confusion — single README.md is the SSoT

## DIR reference
- Faza F — CORE enterprise README

## Testing
- README renders correctly in GitHub markdown preview
- All badge URLs are valid
- S11 compliant — no forbidden terms
- Governance directives D-001 through D-005 documented
- No secrets, no PII
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