docs: update human-facing docs and AGENTS.md workflow - #647
cline-cloud[bot] merged 7 commits into
Conversation
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Up to standards ✅🟢 Issues
|
🔥 Roast: the best PR in the queue is filed under the wrong titleCredit where it is due — this is the only green PR here: 47 checks pass, But it is filed as The security fix hiding in a docs PR "overrides": {
- "brace-expansion": "5.0.9",
+ "brace-expansion": "5.0.12",
All three are DoS / stack-exhaustion issues, and This should be its own PR. The repo has a Now the roastThis PR says it was made "following anti-ai-slop and readme-best-practices guidelines". Let us audit that claim against the two index tables it built: Project Documentation table — lists 4 documents. Missing: Skills table — lists 5 skills. Missing 11, including the very skills this repo's own workflows invoke. Tabulating a list is the moment to notice it is incomplete; the table made the staleness more visible, not less. The README —
VerdictKeep — genuinely useful, and the only PR that is actually mergeable. Two asks:
|
AGENTS.md listed 4 of the 16 documents in agents-docs/ and 5 of the 16 skills in .agents/skills/. Both tables are now complete, with descriptions taken from each skill's own frontmatter. README.md is 178 lines with 19 headings and had no Table of Contents, which readme-best-practices flags as a defect for READMEs over 100 lines. Anchors for the repeated "Rust CLI (do-wdr)" and "Web UI" headings use the -1 suffix GitHub generates. markdownlint-cli2: 0 issues. Refs #647
# Conflicts: # web/package.json
What
Refreshes the human-facing docs and completes the
AGENTS.mdindex tables.AGENTS.md: the Project Documentation table listed 4 of the 16 documents inagents-docs/, and the Skills table listed 5 of the 16 skills in.agents/skills/. Both are now complete, with descriptions taken from eachskill's own frontmatter rather than paraphrased.
README.md: adds the Table of Contents thatreadme-best-practicesrequiresfor READMEs over 100 lines.
README.md("Linting clean" -> "Lint clean", and similar).Split out
The
brace-expansionoverride bump that was originally bundled here is now itsown PR: #648. It resolves two high-severity advisories and should not have to
wait behind a docs review.
Verification
npx markdownlint-cli2 README.md AGENTS.md-> 0 issues.AGENTS.mdis 108 lines, within theMAX_LINES_AGENTS_MD=150limit.