Skip to content

docs(readme): overhaul project overview - #5

Merged
connorcarpenter15 merged 3 commits into
mainfrom
docs/readme-overhaul
Jul 9, 2026
Merged

docs(readme): overhaul project overview#5
connorcarpenter15 merged 3 commits into
mainfrom
docs/readme-overhaul

Conversation

@connorcarpenter15

Copy link
Copy Markdown
Member

Summary

  • redesign the README header with project badges, quick links, and a table of contents
  • describe the current OpenEngine architecture, capabilities, RPC surface, generation stream, error model, and schema compatibility contract
  • add validated setup and schema-checking commands, repository navigation, project status, contribution, security, license, and ecosystem links
  • preserve the experimental pre-adoption status without presenting the API as stable or implemented today

Why

The previous README predates the latest generation, discovery, error, and lifecycle contract changes. This update makes the repository easier to understand and navigate while giving OpenEngine a polished project landing page.

Validation

  • GitHub GFM rendering API
  • local link and asset target checks
  • buf build
  • buf lint
  • buf breaking --against '.git#branch=main,subdir=proto'
  • git diff --check

Signed-off-by: Connor Carpenter <connorc@nvidia.com>
Signed-off-by: Connor Carpenter <connorc@nvidia.com>
Signed-off-by: Connor Carpenter <connorc@nvidia.com>
@connorcarpenter15
connorcarpenter15 marked this pull request as ready for review July 9, 2026 22:13
@connorcarpenter15
connorcarpenter15 merged commit efe4b22 into main Jul 9, 2026
1 check passed
@connorcarpenter15
connorcarpenter15 deleted the docs/readme-overhaul branch July 9, 2026 22:13
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