docs: expand README with usage, status, and org wordmark - #6
Merged
Conversation
The README had fallen behind the code: it was a bare design-doc index from before the pipeline was implemented, listed only four of the six design docs, and described nothing runnable. Rewrite it to reflect the current state — the IR package and OpenAPI 3.x compiler are implemented and driven end-to-end by `morphic compile`. Add install and usage (CLI flags, exit codes, and a library snippet through the engine), a milestone status table, the enforced package-layout table, the full design-doc set, and the build/gate commands. Adopt the dexpace README conventions used across the org SDK repos: the theme-aware wordmark header, badge row, and contents nav. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The README had fallen behind the code. It was a bare design-doc index written before the pipeline existed: it listed only four of the six design docs, described nothing runnable, and predated the
compilers → passes → emittersvocabulary now used throughout the repo.This rewrite brings it up to date and aligns it with the README conventions used across the org's SDK repos.
irpackage and OpenAPI 3.x compiler are implemented and driven end-to-end bymorphic compile; emitters are not built yet. An honest status callout says so, and a milestone table tracks what's shipped versus planned.enginepackage.emitter-design.mdandreference-learnings.md, both previously missing), and the Building commands that mirror the CIgate.Docs only — no code changes.
Test plan
engineAPI (New() (*Engine, error),Run(ctx, path, RunOptions{}) (*Result, error),Result.Document/.Diagnostics).cmd/morphic/compile.go.docs/.<picture>+prefers-color-scheme.🤖 Generated with Claude Code