Skip to content

Conversation

@sonupreetam
Copy link

@sonupreetam sonupreetam commented Dec 24, 2025

Comprehensive overhaul of SUBPROJECTS.md documentation

Summary

This PR transforms SUBPROJECTS.md from a minimal listing into a comprehensive, well-organized reference document for the entire ComplyTime ecosystem. The document now serves as a single source of truth for understanding all projects under the ComplyTime umbrella.

Key Improvements

Project Lifecycle Status System

Introduced a clear status system to communicate project maturity:

Status Meaning
🟢 Active Production-ready, actively maintained
🟡 Incubating Under development, working toward stability
🔵 Supporting Foundational/utility, stable but lower cadence
⚪ Archived Historical reference only

Organized Categories

Projects are now grouped into logical sections:

  • Core Projects — Primary user-facing tools (complytime, complyctl, complyscribe, etc.)
  • SDKs & Libraries — Foundational libraries (oscal-sdk-go, compliance-to-policy-go, etc.)
  • Content & Policies — Compliance content and policy definitions
  • Infrastructure & Tooling — CI/CD, templates, and developer tooling
  • Community — Governance and contribution docs

Visual Ecosystem Diagram

Added an ASCII diagram showing the relationships between ComplyTime projects

Governance Documentation

Added clear processes for:

  • Proposing new subprojects — Criteria, review process, TOC approval
  • Archiving subprojects — Conditions and procedures
  • Subproject criteria — Alignment, scope, maintainers, licensing

Quick Reference Summary Table

A comprehensive table at the end provides an at-a-glance view of all 21 repositories with their category, status, and description.

Related

  • Complements the upcoming CI validation workflow for SUBPROJECTS.md coverage

Signed-off-by: sonupreetam <spreetam@redhat.com>
@sonupreetam sonupreetam force-pushed the docs/improve-subprojects branch from e5f6af5 to c0fd20b Compare December 24, 2025 15:50
@sonupreetam sonupreetam marked this pull request as ready for review December 24, 2025 15:53
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