chore: Standardize and rewrite README files#5
Conversation
Rename workspace from md-docrs-proxy to md-docrs and harmonize README content across top-level and crate docs (crates/md-docrs-*, wasm/, zig/). Clarify usage, build, and release instructions.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: c79effdb3d
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| - `GET /?spec=<crate[@version][::path::to::item]>` | ||
| - `GET /?spec=<crate[@version][::path::to::item]>&target=<triple>` |
There was a problem hiding this comment.
?spec server route documentation
The README now documents GET /?spec=... routes, but md-docrs-server does not implement them: the router only binds /, /healthz, and path-based crate routes, and root() always returns a static usage string instead of dispatching by query (crates/md-docrs-server/src/server.rs, router/root). Users following these examples will get a non-Markdown usage response rather than rendered docs.
Useful? React with 👍 / 👎.
| - `GET /?spec=<crate[@version][::path::to::item]>&target=<triple>` | ||
| - `GET /healthz` | ||
|
|
||
| The server also accepts `?target=<triple>` on path-based requests. |
There was a problem hiding this comment.
?target in server README
The new docs state that path-based requests accept ?target=<triple>, but the server never reads query parameters and always constructs ItemSpec with target: None in serve(...) (crates/md-docrs-server/src/server.rs). This is a behavior mismatch: callers who pass ?target= will silently get default-target docs, which can produce incorrect item pages for target-specific APIs.
Useful? React with 👍 / 👎.
1 participant
Rename workspace from md-docrs-proxy to md-docrs and harmonize README content across top-level and crate docs (crates/md-docrs-*, wasm/, zig/). Clarify usage, build, and release instructions.