docs: root README monorepo map + stale package-doc audit#69
Open
pablo-rerun wants to merge 2 commits into
Open
docs: root README monorepo map + stale package-doc audit#69pablo-rerun wants to merge 2 commits into
pablo-rerun wants to merge 2 commits into
Conversation
Root README rewritten as a 2-minute orientation: what the Pixi workspace is, a verified 3-step quick start, optional direnv workflow, a complete 25-package index, and the env/task/--frozen conventions. AGENTS.md corrected to distinguish runnable, build-only, vendored, and docs-only packages. Eleven package READMEs fixed against actual pixi.toml tasks, environments, and paths (wrong env flags, dead links, renamed tasks, obsolete prerelease claims). Every remaining claim was checked against the task list or file tree; ambiguous items were left alone. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Collaborator
Author
|
@copilot resolve the merge conflicts in this pull request |
Resolved the merge conflicts by merging |
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.
What
Documentation-only pass over the monorepo (split out of #68, which keeps the gsplat-specific docs):
README.mdrewritten as a 2-minute orientation: Pixi workspace model, a verified 3-step quick start (install pixi → install one dev env → run its demo), optional direnv workflow, a complete 25-package index, and the env/task/--frozenconventions.AGENTS.mdcorrected to distinguish runnable, build-only, vendored, and docs-only packages instead of treating every directory as a runnable Python package.pixi.toml: wrong/missing-e <env>flags (dpvo, mv-api, prompt-da, sam3, sam3d-body, robocap-slam), dead file references (mamma), wrong build claims (mast3r-slam: Mojo not CUDA kernels), obsolete prerelease pin claims (simplecv →rerun-sdk==0.34.1), stale platform warnings (slam-evals), and nonexistent abbreviated task names (wilor-nano).Verification
Every claim added or kept was checked against
pixi task list, the[environments]table, or the file tree. Ambiguous items (external clone instructions, PyVRS sensor-count wording) were deliberately left unchanged. Known gaps not addressed here:asmkhas no run command documented,dpretrievalhas no README.🤖 Generated with Claude Code