Repository navigation
docs: make the README a front page - #33
Merged
Merged
Conversation
This was referenced Sep 16, 2026
LalitMaganti
force-pushed
the
readme-rationalize
branch
5 times, most recently
from
September 16, 2026 13:25
bd146a6 to
5fa2ac5
Compare
The README had grown to 409 lines, most of it reference material: GitHub Actions, remote machines, collection options, compiler details, the build systems the conformance suite covers, daemon and container troubleshooting, the trace format's compatibility rules, and self-hosting the UI. Anyone arriving to find out what Buildprof is had to scroll past all of it, and the features worth knowing about were buried among the parts that are only needed once. The front page now names each feature in a line of its own, with the flag that turns it on and a link to the detail: the process tree, file producers and consumers, compiler internals, recordings from CI, builds over SSH, lighter collection, and where the data goes. Installation folds each method away behind what it is called. The reference material moves into docs/ unchanged: usage.md, build-systems.md, troubleshooting.md and internals.md, with the README carrying an index. The /diagnose/ links the CLI prints are redirects, so they now point at the troubleshooting document, and the release metadata check reads the action's version example from its new home.
LalitMaganti
force-pushed
the
readme-rationalize
branch
from
September 16, 2026 13:31
5fa2ac5 to
b62b296
Compare
LalitMaganti
marked this pull request as ready for review
September 16, 2026 13:32
LalitMaganti
added a commit
that referenced
this pull request
Sep 16, 2026
The example the release tooling rewrites moved to the usage guide when the README became a front page (#33), and `infra/prepare-action-release` moved with it. Its test kept building a tree with the example in `README.md`, so every case in `test_action_release.py` now fails on a missing file. Point the fixture at `docs/usage.md`, and snapshot files with `rglob` since the tree now has a directory in it.
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.
No description provided.