Skip to content

docs: link projex agent skill from README + CLI reference - #44

Merged
ManningWorks merged 2 commits into
mainfrom
docs/projex-skill-links
Oct 12, 2026
Merged

ManningWorks merged 2 commits into
mainfrom
docs/projex-skill-links

Conversation

@ManningWorks

Copy link
Copy Markdown
Owner

Summary

Makes the new Projex agent skill (PR #40) discoverable from the two customer entry points:

  • README.md — short 'Agent skill' block inside the CLI section: what it is (teaches any coding agent to drive the Projex CLI end-to-end: init, components, content, config), where it lives (skills/projex/), one-line install hint.
  • packages/docs/src/cli.md — 'Agent Skill' section at the end of the CLI reference pointing to skills/projex/.

Both reference the skill via the PR #40 branch path (skills/ not on main yet) with an explicit note that it lands on main via PR #40. No existing content restructured — 10 added lines total.

Related

Add a short 'Agent skill' block to the README CLI section and an
'Agent Skill' section to the CLI reference (packages/docs/src/cli.md),
both pointing to skills/projex/ (landing on main via PR #40) with a
one-line install hint. No existing content restructured.
@vercel

vercel Bot commented Oct 12, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
projex-docs Ready Ready Preview Oct 12, 2026 4:44am UTC

@coderabbitai

coderabbitai Bot commented Oct 12, 2026 •

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 00ce73ef-5762-45d1-b417-b28240de9716

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@ManningWorks

Copy link
Copy Markdown
Owner Author

Review: NEEDS-EDITS

Reviewed the diff (README.md +4, packages/docs/src/cli.md +6 — pure additions, 10 lines) plus live link/branch state on GitHub. Verdict: NEEDS-EDITS — one blocking link-durability bug (present in both files) and one transient wording issue (both files). Scope and placement are clean.


🔴 F1 — HIGH · Introduced · Blocking — branch-pinned URL will 404 after PR #40 merges

README.md:101 and packages/docs/src/cli.md:741 both link the skill at:

https://github.com/ManningWorks/Projex/tree/skill/projex-agent-skill/skills/projex

That is a feature-branch URL (skill/projex-agent-skill = the head of PR #40). Feature branches are transient — when PR #40 merges and its head branch is deleted, this URL dies.

Verified, not assumed: a tree/<branch>/path URL for a branch that no longer exists returns HTTP 404 — it does not redirect to the originating PR. The handoff note that this link "redirects to PR #40 after merge" is incorrect. So the current link is not safe: it works today (branch exists → 200) but permanently 404s once skill/projex-agent-skill is gone.

Fix (both files): point at the default branch:

https://github.com/ManningWorks/Projex/tree/main/skills/projex

⚠️ Merge-order dependency (this is why the fix is not drop-in): tree/main/skills/projex currently returns 404 because the skill is not on main yet (PR #40 is still OPEN). So:

Please do not merge this before PR #40.


🟡 F2 — MEDIUM · Introduced — transient "lands on main via PR #40" reads stale after #40 merges

Same line in both files ends with:

The skill lands on main via PR #40.

That is a forward-looking statement that becomes stale the moment PR #40 merges (and becomes redundant once F1's fix points the link at main directly).

Fix (both files): drop the "lands on main" phrasing. Optionally keep a permanent pointer: Added in [PR #40](https://github.com/ManningWorks/Projex/pull/40). Either is fine; the transient "lands on main" wording should go.


🟢 F3 — LOW · Adjacent · Non-blocking — capability claim vs issue #42

The block says the skill "teaches any coding agent to drive the Projex CLI end-to-end — init, components, content, and config." Per issue #42 (open), the published @manningworks/projex@1.6.0 CLI crashes on the first command (npx/npm install don't install the optional peers), so init is not actually end-to-end drivable for published-package consumers today.

Tagged adjacent rather than a required change here: the broken-npx accuracy problem lives in the skill's content (PR #40) and is tracked in issue #42 — this PR makes no npx claim (the new text never mentions npx; the install hint is a copy-into-skills-dir, which is fine and correct). No blocking issue. Optional softening if desired: documents how to drive the Projex CLI.


✅ Checks that passed

  • Scope (F4): clean. Diff vs origin/main is exactly README.md (+4/−0) and packages/docs/src/cli.md (+6/−0). Pure additions; no existing content restructured.
  • Placement: README block is correctly nested as ### Agent skill inside the CLI section (after the npx examples, before ## Documentation); cli.md appends an ## Agent Skill section after a --- separator. Both good.
  • Consistency: README and cli.md blocks match (same description, link, install hint, PR docs: add projex agent skill (skills/projex) #40 note) — so both carry the same F1+F2 defects and need the same fix in both places.

Net: two-line fix (branch→main URL) + one wording fix, applied to both files, with PR #40 merged first. Everything else is sound.

Addresses review of PR #44:
- F1: /tree/skill/projex-agent-skill/... 404s once PR #40's head
  branch is deleted; point both links at /tree/main/skills/projex.
- F2: replace transient 'lands on main via PR #40' with the
  permanent 'Added in PR #40' pointer.
@ManningWorks

Copy link
Copy Markdown
Owner Author

Applied the review feedback in commit 366eaa5:

  • F1 (HIGH): skill link in both README.md and packages/docs/src/cli.md now points at `/tree/main/skills/projex` instead of the `skill/projex-agent-skill` feature branch (which would 404 once PR docs: add projex agent skill (skills/projex) #40's head branch is deleted).
  • F2 (MEDIUM): dropped the transient `lands on main` phrasing; the line now ends with the permanent pointer `Added in PR #40.`.
  • F3 (LOW): left as-is (non-blocking, no npx claim in this PR).

Ready for re-review. Merge after PR #40 lands (merge-order dependency on `/tree/main/skills/projex` resolving).

@ManningWorks

Copy link
Copy Markdown
Owner Author

Re-review: APPROVE

Re-reviewed the fix commit 366eaa5 against the two blocking findings. Both resolved; no new findings. The merge-order dependency is now satisfied (PR #40 has merged, so skills/projex is on main).

Scope: clean. Diff vs main is exactly README.md (+4) and packages/docs/src/cli.md (+6), pure additions, 10 lines total; placement unchanged and sane.

Ready to merge. No action taken on the branch by review.

@ManningWorks
ManningWorks merged commit f40f7fa into main Oct 12, 2026
7 checks passed

This branch was successfully deployed

1 active deployment
Preview — 366eaa58 Deployed Oct 12, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant