Skip to content

docs: Overhaul README for spec-repository positioning#97

Merged
nordiclion merged 2 commits intomainfrom
docs/readme-spec-alignment
Feb 23, 2026
Merged

docs: Overhaul README for spec-repository positioning#97
nordiclion merged 2 commits intomainfrom
docs/readme-spec-alignment

Conversation

@kernel-gd
Copy link
Copy Markdown
Collaborator

Summary

  • Replaces the entire product/marketing README with a spec-repository README aligned to GenOps v0.1
  • Removes: SDK Quick Start, Python code examples, 50+ integration lists, dashboard mockups, badge shields, persona sections, trademark/legal boilerplate, promotional CTAs
  • Adds: What GenOps Is, Why This Exists, Design Principles, Relationship to OpenTelemetry, Compliance, What GenOps Does Not Define, Versioning, Repository Structure, Contributing, Status, License
  • Net reduction: 439 lines removed, 83 lines added

Test plan

  • Verify no vendor references, no SDK/implementation content, no marketing language
  • Verify all links resolve (spec file, LICENSE)
  • Verify tone reads as standards-grade, CNCF-legible

🤖 Generated with Claude Code

Replace product/marketing README with spec-repository positioning.
Removes SDK examples, integration lists, dashboard mockups, badge
shields, and promotional content. Replaces with standards-grade
sections: What GenOps Is, Why This Exists, Design Principles,
Relationship to OpenTelemetry, Compliance, and Contributing.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@github-actions github-actions bot added documentation Improvements or additions to documentation size/XS labels Feb 23, 2026
Signed-off-by: nordiclion <76140178+nordiclion@users.noreply.github.com>
@github-actions
Copy link
Copy Markdown

❌ DCO Check Failed

Your commits are missing the required "Signed-off-by" line.

How to fix this:

  1. For new commits, use the -s flag:

    git commit -s -m "Your commit message"
  2. To fix existing commits in your PR:

    # For the last commit
    git commit --amend --signoff
    
    # For multiple commits (replace N with number of commits)
    git rebase --signoff HEAD~N
    
    # Force push the updated commits
    git push --force-with-lease

What is DCO?

The Developer Certificate of Origin (DCO) is a legally lightweight way for contributors to confirm they have the right to submit code to the project.

By signing off, you certify that:

Need help?

Check our Contributing Guide or ask questions in this PR!

@nordiclion nordiclion merged commit 6b9809a into main Feb 23, 2026
7 of 15 checks passed
@nordiclion nordiclion deleted the docs/readme-spec-alignment branch February 23, 2026 23:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/XS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants