Skip to content

Latest commit

 

History

History
531 lines (432 loc) · 15.9 KB

File metadata and controls

531 lines (432 loc) · 15.9 KB

Hyperpolymath Badge Schema

1. Overview

Comprehensive badge structure for the 139-repo ecosystem, capturing:

  • Project status and maturity

  • Language tiers and compliance

  • Cross-project relationships

  • Infrastructure and tooling

  • Security and governance

2. Badge Categories

2.1. 1. Project Identity

Badge Purpose Example

RSR Tier

Language compliance level

RSR Tier%201 gold

Project Phase

Development lifecycle

Phase Implementation blue

Maturity

Production readiness

Maturity Production brightgreen

2.1.1. RSR Tier Badges

// Tier 1 (Gold) - Rust, Elixir, Zig, Ada, Haskell, ReScript
image:https://img.shields.io/badge/RSR-Tier%201-gold[RSR Tier 1]

// Tier 2 (Silver) - Nickel, Racket, Guile, Nix
image:https://img.shields.io/badge/RSR-Tier%202-silver[RSR Tier 2]

// Infrastructure (Bronze) - Guix channels, derivations
image:https://img.shields.io/badge/RSR-Infrastructure-cd7f32[RSR Infrastructure]

2.1.2. Phase Badges

image:https://img.shields.io/badge/Phase-Design-lightgrey[Design]
image:https://img.shields.io/badge/Phase-Implementation-blue[Implementation]
image:https://img.shields.io/badge/Phase-Testing-yellow[Testing]
image:https://img.shields.io/badge/Phase-Maintenance-brightgreen[Maintenance]
image:https://img.shields.io/badge/Phase-Archived-red[Archived]

2.1.3. Maturity Badges

image:https://img.shields.io/badge/Maturity-Experimental-orange[Experimental]
image:https://img.shields.io/badge/Maturity-Alpha-yellow[Alpha]
image:https://img.shields.io/badge/Maturity-Beta-blue[Beta]
image:https://img.shields.io/badge/Maturity-Production-brightgreen[Production]
image:https://img.shields.io/badge/Maturity-LTS-green[LTS]

2.2. 2. Language & Stack

Badge Purpose Example

Primary Language

Main implementation language

Rust 1

Secondary Languages

Supporting languages

Also ReScript%20%7C%20Nickel blue

Build System

Package/build tooling

Guix Primary purple

2.2.1. Language Badges (Tier 1)

image:https://img.shields.io/badge/Rust-1.75+-orange?logo=rust[Rust]
image:https://img.shields.io/badge/Elixir-1.16+-purple?logo=elixir[Elixir]
image:https://img.shields.io/badge/ReScript-11+-pink?logo=rescript[ReScript]
image:https://img.shields.io/badge/Zig-0.13-yellow?logo=zig[Zig]
image:https://img.shields.io/badge/Ada-2022-blue[Ada]
image:https://img.shields.io/badge/Haskell-GHC%209-purple?logo=haskell[Haskell]

2.2.2. Language Badges (Tier 2)

image:https://img.shields.io/badge/Nickel-1.5+-teal[Nickel]
image:https://img.shields.io/badge/Guile-3.0+-green[Guile Scheme]
image:https://img.shields.io/badge/Racket-8.12+-red?logo=racket[Racket]
image:https://img.shields.io/badge/Nix-Flakes-5277C3?logo=nixos[Nix]

2.2.3. Build System Badges

image:https://img.shields.io/badge/Guix-Primary-purple?logo=gnu[Guix Primary]
image:https://img.shields.io/badge/Nix-Fallback-5277C3?logo=nixos[Nix Fallback]
image:https://img.shields.io/badge/Cargo-Workspace-orange?logo=rust[Cargo]
image:https://img.shields.io/badge/Mix-Project-purple?logo=elixir[Mix]

2.3. 3. Cross-Project Relationships

Badge Purpose Example

Depends On

Runtime/build dependency

Depends conative—​gating blue

Part Of

Component of larger system

Part%20Of STATE

Supersedes

Replaces older project

Supersedes echomesh red

Integrates

Works with (bidirectional)

Integrates fogbinder yellow

2.3.1. Relationship Badges

// Dependency chain
image:https://img.shields.io/badge/Depends-conative--gating-blue[Depends: conative-gating]
image:https://img.shields.io/badge/Depends-elegant--STATE-blue[Depends: elegant-STATE]
image:https://img.shields.io/badge/Depends-wharf-blue[Depends: wharf]

// Composition
image:https://img.shields.io/badge/Part%20Of-STATE.scm%20Ecosystem-green[Part Of: STATE.scm]
image:https://img.shields.io/badge/Part%20Of-RSR%20Framework-green[Part Of: RSR Framework]
image:https://img.shields.io/badge/Part%20Of-Consent%20Aware%20HTTP-green[Part Of: Consent-Aware-HTTP]

// Evolution
image:https://img.shields.io/badge/Supersedes-echomesh-red[Supersedes: echomesh]
image:https://img.shields.io/badge/Superseded%20By-conative--gating-grey[Superseded By: conative-gating]

// Integration
image:https://img.shields.io/badge/Integrates-Zotero-yellow[Integrates: Zotero]
image:https://img.shields.io/badge/Integrates-WordPress-yellow[Integrates: WordPress]

2.4. 4. Domain & Capability

Badge Purpose Example

Domain

Problem space

Domain Misinformation%20Defence red

Capability

What it provides

Capability Policy%20Enforcement blue

Stack Position

Infrastructure layer

Layer Application green

2.4.1. Domain Badges

// Core Domains
image:https://img.shields.io/badge/Domain-AI%20Safety-critical[AI Safety]
image:https://img.shields.io/badge/Domain-Misinformation%20Defence-red[Misinformation Defence]
image:https://img.shields.io/badge/Domain-Developer%20Tools-blue[Developer Tools]
image:https://img.shields.io/badge/Domain-Citation%20Management-purple[Citation Management]
image:https://img.shields.io/badge/Domain-WordPress%20Ecosystem-informational[WordPress]
image:https://img.shields.io/badge/Domain-IndieWeb-green[IndieWeb]
image:https://img.shields.io/badge/Domain-IoT%2FRobotics-orange[IoT/Robotics]
image:https://img.shields.io/badge/Domain-Accessibility-blueviolet[Accessibility]

2.4.2. Capability Badges

image:https://img.shields.io/badge/Capability-Policy%20Enforcement-blue[Policy Enforcement]
image:https://img.shields.io/badge/Capability-Validation-green[Validation]
image:https://img.shields.io/badge/Capability-Transformation-yellow[Transformation]
image:https://img.shields.io/badge/Capability-Orchestration-purple[Orchestration]
image:https://img.shields.io/badge/Capability-Analysis-orange[Analysis]

2.4.3. Stack Layer Badges

image:https://img.shields.io/badge/Layer-Infrastructure-grey[Infrastructure]
image:https://img.shields.io/badge/Layer-Library-blue[Library]
image:https://img.shields.io/badge/Layer-Service-green[Service]
image:https://img.shields.io/badge/Layer-Application-brightgreen[Application]
image:https://img.shields.io/badge/Layer-CLI-orange[CLI]

2.5. 5. Infrastructure & Compliance

Badge Purpose Example

Container

Container runtime

Container nerdctl%20%2B%20Wolfi blue

CI/CD

Pipeline platform

CI GitHub%20Actions%20%2B%20GitLab green

License

Dual license

License AGPL%20%2B%20Palimpsest blue

2.5.1. Container Badges

image:https://img.shields.io/badge/Container-nerdctl-blue?logo=containerd[nerdctl]
image:https://img.shields.io/badge/Base-Wolfi-purple?logo=chainguard[Wolfi Base]
image:https://img.shields.io/badge/Base-Distroless-black[Distroless]
image:https://img.shields.io/badge/OCI-Compliant-green[OCI Compliant]

2.5.2. CI/CD Badges

image:https://img.shields.io/badge/CI-GitHub%20Actions-2088FF?logo=github-actions[GitHub Actions]
image:https://img.shields.io/badge/CI-GitLab%20CI-FC6D26?logo=gitlab[GitLab CI]
image:https://img.shields.io/badge/Security-Trivy%20%2B%20GitLeaks-green[Security Scanning]

2.5.3. License Badges

image:https://img.shields.io/badge/License-AGPL%203.0-blue[AGPL 3.0]
image:https://img.shields.io/badge/License-Palimpsest%200.5-green[Palimpsest 0.5]
image:https://img.shields.io/badge/License-AGPL%20OR%20Palimpsest-blue[Dual License]

2.6. 6. Security & Governance

Badge Purpose Example

Security

Security posture

Security RFC%209116 green

Privacy

Privacy compliance

Privacy GDPR%20Ready brightgreen

Governance

Decision model

Governance BDFL blue

2.6.1. Security Badges

image:https://img.shields.io/badge/Security-RFC%209116-green[RFC 9116]
image:https://img.shields.io/badge/Security-Verified-brightgreen[Verified]
image:https://img.shields.io/badge/Vulnerability-None%20Known-brightgreen[No Known CVEs]
image:https://img.shields.io/badge/SBOM-Available-blue[SBOM Available]

2.6.2. Privacy Badges

image:https://img.shields.io/badge/Privacy-GDPR%20Ready-brightgreen[GDPR Ready]
image:https://img.shields.io/badge/Privacy-Offline%20First-green[Offline First]
image:https://img.shields.io/badge/Privacy-No%20Telemetry-blue[No Telemetry]
image:https://img.shields.io/badge/Consent-Required-yellow[Consent Required]

2.6.3. Governance Badges

image:https://img.shields.io/badge/Governance-BDFL-blue[BDFL]
image:https://img.shields.io/badge/Governance-Meritocracy-green[Meritocracy]
image:https://img.shields.io/badge/TPCF-Perimeter%203-orange[TPCF Perimeter 3]

3. Standard Badge Block Template

3.1. Minimal (All Projects)

// Identity
image:https://img.shields.io/badge/RSR-Tier%201-gold[RSR Tier]
image:https://img.shields.io/badge/Phase-Implementation-blue[Phase]
image:https://img.shields.io/badge/Maturity-Beta-blue[Maturity]

// License
image:https://img.shields.io/badge/License-AGPL%20OR%20Palimpsest-blue[License]

// Build
image:https://img.shields.io/badge/Guix-Primary-purple?logo=gnu[Guix]
image:https://img.shields.io/badge/CI-Passing-brightgreen[CI Status]

3.2. Standard (Active Projects)

// Identity
image:https://img.shields.io/badge/RSR-Tier%201-gold[RSR Tier]
image:https://img.shields.io/badge/Phase-Implementation-blue[Phase]
image:https://img.shields.io/badge/Maturity-Beta-blue[Maturity]

// Language
image:https://img.shields.io/badge/Rust-1.75+-orange?logo=rust[Rust]
image:https://img.shields.io/badge/Also-Nickel%20%7C%20Guile-blue[Also]

// Ecosystem
image:https://img.shields.io/badge/Part%20Of-STATE.scm-green[Part Of]
image:https://img.shields.io/badge/Depends-wharf-blue[Depends]

// Domain
image:https://img.shields.io/badge/Domain-AI%20Safety-critical[Domain]
image:https://img.shields.io/badge/Layer-Service-green[Layer]

// Infrastructure
image:https://img.shields.io/badge/Guix-Primary-purple?logo=gnu[Guix]
image:https://img.shields.io/badge/Container-nerdctl-blue[Container]
image:https://img.shields.io/badge/CI-GitHub%20%2B%20GitLab-green[CI]

// Compliance
image:https://img.shields.io/badge/License-AGPL%20OR%20Palimpsest-blue[License]
image:https://img.shields.io/badge/Security-RFC%209116-green[Security]
image:https://img.shields.io/badge/Privacy-GDPR%20Ready-brightgreen[Privacy]

3.3. Full (Flagship Projects)

// Identity Row
image:https://img.shields.io/badge/RSR-Tier%201-gold[RSR]
image:https://img.shields.io/badge/Phase-Production-brightgreen[Phase]
image:https://img.shields.io/badge/Maturity-LTS-green[Maturity]
image:https://img.shields.io/badge/v1.0.0-stable-brightgreen[Version]

// Language Row
image:https://img.shields.io/badge/Rust-1.75+-orange?logo=rust[Rust]
image:https://img.shields.io/badge/Elixir-1.16+-purple?logo=elixir[Elixir]
image:https://img.shields.io/badge/Nickel-Config-teal[Nickel]
image:https://img.shields.io/badge/Guile-State-green[Guile]

// Ecosystem Row
image:https://img.shields.io/badge/Part%20Of-STATE.scm-green[Part Of]
image:https://img.shields.io/badge/Depends-wharf%20%7C%20file--soup-blue[Dependencies]
image:https://img.shields.io/badge/Supersedes-echomesh-red[Supersedes]
image:https://img.shields.io/badge/Integrates-Zotero%20%7C%20WordPress-yellow[Integrates]

// Domain Row
image:https://img.shields.io/badge/Domain-AI%20Safety-critical[Domain]
image:https://img.shields.io/badge/Capability-Policy%20Enforcement-blue[Capability]
image:https://img.shields.io/badge/Layer-Service-green[Layer]

// Infrastructure Row
image:https://img.shields.io/badge/Guix-Primary-purple?logo=gnu[Guix]
image:https://img.shields.io/badge/Nix-Fallback-5277C3?logo=nixos[Nix]
image:https://img.shields.io/badge/Container-nerdctl%20%2B%20Wolfi-blue[Container]

// CI/CD Row
image:https://img.shields.io/badge/CI-GitHub%20Actions-2088FF?logo=github-actions[GitHub]
image:https://img.shields.io/badge/CI-GitLab%20CI-FC6D26?logo=gitlab[GitLab]
image:https://img.shields.io/badge/Security-Trivy%20%2B%20GitLeaks-green[Scanning]

// Compliance Row
image:https://img.shields.io/badge/License-AGPL%20OR%20Palimpsest-blue[License]
image:https://img.shields.io/badge/Security-RFC%209116-green[Security.txt]
image:https://img.shields.io/badge/Privacy-GDPR%20Ready-brightgreen[GDPR]
image:https://img.shields.io/badge/SBOM-Available-blue[SBOM]

4. Dynamic Badge Generation

4.1. Justfile Recipe

# Generate badge block from project metadata
badges:
    @./scripts/generate-badges.sh > docs/BADGES.adoc
    @echo "Badges generated in docs/BADGES.adoc"

# Update README with current badges
update-readme-badges:
    @./scripts/update-readme-badges.sh README.adoc

4.2. Generation Script Pattern

#!/bin/bash
# scripts/generate-badges.sh

# Read from STATE.scm or project config
PHASE=$(grep -oP "phase\s*\.\s*\"\K[^\"]*" STATE.scm 2>/dev/null || echo "development")
TIER=$(detect_rsr_tier)
MATURITY=$(grep -oP "maturity\s*\.\s*\"\K[^\"]*" STATE.scm 2>/dev/null || echo "experimental")

# Generate badge URLs
echo "image:https://img.shields.io/badge/RSR-Tier%20${TIER}-${TIER_COLOR}[RSR Tier ${TIER}]"
echo "image:https://img.shields.io/badge/Phase-${PHASE}-blue[Phase: ${PHASE}]"
echo "image:https://img.shields.io/badge/Maturity-${MATURITY}-${MAT_COLOR}[Maturity: ${MATURITY}]"

5. Cross-Reference Matrix

Projects can be tracked via their relationships in ECOSYSTEM.scm:

(relationships
  ;; Core Framework
  ((from . "STATE.scm") (to . "elegant-STATE") (kind . defines))
  ((from . "STATE.scm") (to . "conative-gating") (kind . defines))

  ;; Dependency Graph
  ((from . "conative-gating") (to . "wharf") (kind . depends))
  ((from . "conative-gating") (to . "file-soup") (kind . depends))
  ((from . "zotero-nsai") (to . "fogbinder") (kind . integrates))

  ;; Evolution
  ((from . "conative-gating") (to . "echomesh") (kind . supersedes))
  ((from . "conative-gating") (to . "UPM") (kind . supersedes)))

6. Badge Color Scheme

Color Code Hex Usage

brightgreen

#4c1

Production, LTS, Passing, Compliant

green

#97ca00

Maintenance, Security OK, Privacy

blue

#007ec6

Implementation, Dependencies, Info

yellow

#dfb317

Testing, Integrations, Warnings

orange

#fe7d37

Alpha, Rust, Experimental

red

#e05d44

Archived, Superseded, Critical

gold

#ffd700

Tier 1 RSR

silver

#c0c0c0

Tier 2 RSR

purple

#9f4f9f

Guix, Elixir

grey

#555

Design, Infrastructure

7. Integration with ECOSYSTEM.scm

The badge schema should be machine-readable from ECOSYSTEM.scm:

((name . "conative-gating")
 (badges
  ((category . identity)
   (rsr-tier . 1)
   (phase . implementation)
   (maturity . beta))
  ((category . languages)
   (primary . rust)
   (secondary . (elixir nickel guile)))
  ((category . ecosystem)
   (part-of . "STATE.scm")
   (depends . (wharf file-soup))
   (supersedes . (echomesh UPM)))
  ((category . domain)
   (domain . "AI Safety")
   (capability . "Policy Enforcement")
   (layer . service))
  ((category . infrastructure)
   (build-primary . guix)
   (build-fallback . nix)
   (container . (nerdctl wolfi))
   (ci . (github-actions gitlab-ci)))
  ((category . compliance)
   (license . (agpl-3 palimpsest-0.5))
   (security . rfc-9116)
   (privacy . gdpr-ready))))