Rewrite the README for newcomers; lead install with packages#17
Merged
Conversation
The README read like design notes — seal, code_id, and static catalog used without definition, opening on internals rather than what codavox is. Rewritten to lead with a plain description and a Puppet Enterprise mapping (puppet-code deploy -> codavox deploy, file sync -> publish/agent, Code Manager webhook+API -> deploy-server), a glossary that defines environment, static catalog, code_id, and publisher/agent before they are used, a mermaid diagram of the deploy flow across the primary and a compiler, and a plain-language guarantees section. The deep front-page constraints (per-compile latency, the code_id charset) move to design.md, commands.md, and the contract doc — those are contributor depth, not a newcomer's first read. Install now leads with the package (dnf/apt by URL from the releases page) and points at building from source for contributors, rather than making everyone build. installation.md's dnf example is corrected from aarch64 to the real artifact name (linux_arm64), and its stale 'no state file exists' — the state file was removed when code-id moved to reading the symlink — becomes 'the environment link does not exist yet'. Signed-off-by: Michael Harp <mike@mikeharp.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
1 participant
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.
The README read like design notes. Rewritten for a newcomer and a PE migrant.
puppet-code deploy→codavox deploy, file sync → publish/agent, Code Manager webhook+API → deploy-server.code_id, publisher/agent before they're used.code_idcharset) moved to design.md/commands.md/contract where they belong.dnf/aptby URL) instead of making everyone build from source; build-from-source is the contributor path.Also fixes installation.md: the
dnfexample usedaarch64where the real artifact islinux_arm64, and a stale "no state file exists" (the state file was removed whencode-idmoved to reading the symlink) becomes "the environment link does not exist yet."Precedes cutting
v0.1.0, which makes the package URLs resolve.🤖 Generated with Claude Code