Repository navigation
docs(readme): rewrite README as a user-first guide with verified quickstart - #21
Draft
lasomethingsomething wants to merge 3 commits into
Conversation
…kstart Reorients README.md so a fresh install succeeds without reading anything else, while keeping the contributor/maintainer content: - New order: what it is, install, commands, quickstart, generating a profile, command reference, language profilers, build from source, ecosystem map. - Quickstart is the verified validate path: rc profile validate rc-demos/artifacts/request-logger-http.profile.yaml -> "runtimeconditions: profile validated". - Generate section documents the three prerequisites with real error strings verified against the linked go-rc-profiler v0.8.0: Go toolchain on PATH, --dir must contain a go.mod, and published binding modules only (go.mod replace rejected by design with the exact message). - Example workload uses the published modules runtimeconditions.io/x/rc/common@v0.3.0 and .../env@v0.3.0; notes the verified current env v0.3.0 dependency-archive SHA-256 mismatch. - Install paths verified against the org: brew runtimeconditions/tools/rc-cli, https://runtimeconditions.io/packages/setup.sh + apt/dnf, npm @runtimeconditions/typescript-profiler, PyPI runtimeconditions-profiler. - All commands/flags checked against --help output of a binary built from this branch; existing command tables kept; build-from-source section preserves the schema-linker caveat and release-build notes. Generated by Mistral Vibe. Co-Authored-By: Mistral Vibe <vibe@mistral.ai>
lasomethingsomething
marked this pull request as draft
November 18, 2026 23:34
"Your first profile" implied the quickstart creates a profile; it only validates a committed demo one. Heading is now "validate an existing profile" with a one-line clarification. Generated by Mistral Vibe. Co-Authored-By: Mistral Vibe <vibe@mistral.ai>
lasomethingsomething
deleted the
rewrite-readme-user-first-quickstart
branch
November 19, 2026 17:44
lasomethingsomething
restored the
rewrite-readme-user-first-quickstart
branch
November 19, 2026 17:45
This branch has not been deployed
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.
Rewrites
README.mdso a new user who just installed the CLI can succeed without reading anything else, while preserving the maintainer/contributor content.Structure (new)
brew install runtimeconditions/tools/rc-cli), apt/dnf/yum (https://runtimeconditions.io/packages/setup.sh), from source pointerrc --version,rc plugins listwith real outputrc profile validate rc-demos/artifacts/request-logger-http.profile.yaml→runtimeconditions: profile validated(verified against a binary built from this branch)--helpgo buildschema-linker caveat and release-build notesVerified, not assumed
Every command/flag was checked against
--helpoutput of a binary built from this repo. Fresh-install facts were re-run:rc-demosclone →runtimeconditions: profile validatedgo.mod→rc: <dir>: workload must have a go.mod: ...go.modreplaceto a siblingextensionsclone →... uses a go.mod replace; generated bindings must resolve to a published module versionruntimeconditions.io/x/rc/common@v0.3.0exists on the Go proxy and generates a profile that validates;env@v0.3.0currently fails withdependency Go module archive SHA-256 mismatch(documented as a known gap, with the exact string)runtimeconditions/homebrew-tools(Formula/rc-cli.rb),runtimeconditions.io/packages/setup.sh(200), npm@runtimeconditions/typescript-profiler, PyPIruntimeconditions-profilerCloses none of the open issues directly; pairs with #15/#16/#17 docs direction.
Generated by Mistral Vibe.