📝 Fix obsolete information in docs#287
Merged
Merged
Conversation
The README advertised an upcoming USB support transport that was never implemented and has no code anywhere in the tree. Replace the misleading "Multiple transports" bullet with accurate feature bullets, and add the zlink-smol crate, a real workspace member, to the Project Structure list. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UGwiSzPgfKxRGRWq9CZLVV
The examples README only described varlink-inspect, even though the root README lists the resolved example too. Add a section describing what the resolved example does and how to run it. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UGwiSzPgfKxRGRWq9CZLVV
AGENTS.md claimed the idl-parse feature requires std, but the same file's own commands build and test it with --no-default-features, and it compiles cleanly in no_std. Correct the description to reflect that it works in no_std. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UGwiSzPgfKxRGRWq9CZLVV
The Core Architecture section listed zlink-tokio but omitted zlink-smol, a real workspace member. Add it for parity with the tokio entry. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UGwiSzPgfKxRGRWq9CZLVV
zeenix
commented
Jul 12, 2026
zeenix
force-pushed
the
claude/docs-obsolete-info-f6i0ug
branch
from
0122793 to
2d0b7c0
Compare
The README had a second Examples section that re-listed the example programs and their run commands, duplicating the examples directory's own README. Replace it with a short pointer from the existing Examples section so the listing lives in a single place. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UGwiSzPgfKxRGRWq9CZLVV
zeenix
force-pushed
the
claude/docs-obsolete-info-f6i0ug
branch
from
2d0b7c0 to
efa638a
Compare
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
2 participants
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 (and the
AGENTS.mdarchitecture doc) carried some obsolete/incorrect information. This cleans it up across four atomic commits.Changes
zlink-smolto the Project Structure list in the README, and to the Core Architecture list inAGENTS.md. It is a real workspace member but was missing from both (the README Features section already referenced thesmolruntime, so the docs were internally inconsistent).resolvedexample inzlink/examples/README.md. The root README lists both examples, but the examples README only describedvarlink-inspect.idl-parsenote inAGENTS.md. It claimed the feature requiresstd, but the same file's own commands build/test it with--no-default-features, and it compiles cleanly inno_std(verified withcargo check -p zlink-core --no-default-features --features idl-parse,proxy,defmt).All six per-crate
README.mdfiles are symlinks to the rootREADME.md, so the README changes propagate to every crate.CLAUDE.mdis a symlink toAGENTS.md.Notes
Docs-only change; no code is affected.
🤖 Generated with Claude Code
https://claude.ai/code/session_01UGwiSzPgfKxRGRWq9CZLVV
Generated by Claude Code