Repository navigation
Conversation
Approach C from the #1939 decision: book.toml + SUMMARY.md covering all 62 existing markdown files under pkgs/mcpx/docs (no content rewritten), pkgs/mcpx/docs.nix building the book with the pinned mdbook via runCommand, exposed as packages.mcpx-docs alongside mcpx in make-root-apps. Known issue at push time: nix build .#mcpx-docs fails during evaluation in the make-root-apps callPackage scope -- docs.nix is called without required arguments (lib, then mdbook on a second evaluation). Diagnosis continues on the task; CI flake check will show the same. The book files themselves are verified present and SUMMARY.md is generated from the docs tree.
|
Warning Review limit reachedYou've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Next included review available in 45 minutes. View limit details
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
|
Closing as a duplicate of #2629, the canonical PR for queue task 3236 / issue #1939 (same task, opened earlier by another lane; this PR was created under a later claim before #2629 was seen). The two were diffed and a salvage note posted on #2629: nothing unique to port — this PR's book layout and docs.nix are strictly less complete. The nix-eval failure noted in this PR's body was observed only against this branch's worktree and is flagged on #2629 for verification against its own build. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 180e726348
ℹ️ 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".
| }; | ||
| } | ||
| '' | ||
| cp -r ${./docs} book |
There was a problem hiding this comment.
When the generated output is served as a book, existing links to files outside docs/ point outside the published artifact. For example, quick-start.md:49 tells readers to give their agent AGENTS.md, but that file lives at pkgs/mcpx/AGENTS.md and is not copied into the build. The book also links to sibling assessment documents, package sources, and daemon files. Rewrite these outside-tree links to repository URLs during the build, or include their targets in a compatible book layout, so the new site preserves these navigation and onboarding steps.
Useful? React with 👍 / 👎.
Implements Approach C of the #1939 decision (queue task 3236): stand up the mdBook book skeleton for mcpx.
pkgs/mcpx/docs/book.toml— mdBook config; the book source is the docs directory itself, so the markdown that renders on GitHub is the book.pkgs/mcpx/docs/SUMMARY.md— covers all 62 existing markdown files (top-level docs,decisions/,spec/, plus the nested READMEs), titles taken from each file's first heading. No existing content rewritten.pkgs/mcpx/docs.nix— runCommand derivation building the book with the flake's pinnedmdbook, sandboxed, no network.lib/default.nix— exposes it aspackages.mcpx-docsnext tomcpxin make-root-apps.Known issue (recorded on task 3236):
nix build .#mcpx-docscurrently fails at evaluation in the make-root-apps scope —pkgs.callPackage ../pkgs/mcpx/docs.nixreports the function called without required arguments (libon one evaluation,mdbookon the next), i.e. callPackage is not supplying the usual nixpkgs arguments in that scope. The settings docs test and the book files are unaffected; the next worker picks up the diagnosis (fallback if callPackage cannot be fixed there: inline the runCommand in lib/default.nix with pkgs.mdbook referenced directly). Parked for that diagnosis + CI.Need help on this PR? Tag
@codesmith-botwith what you need.