Skip to content

docs: update human-facing docs and AGENTS.md workflow - #647

Merged
cline-cloud[bot] merged 7 commits into
mainfrom
docs/update-docs-and-agents-workflow-13375211053076290983
Oct 1, 2026
Merged

cline-cloud[bot] merged 7 commits into
mainfrom
docs/update-docs-and-agents-workflow-13375211053076290983

Conversation

@d-oit

@d-oit d-oit commented Sep 30, 2026 •

Copy link
Copy Markdown
Owner

What

Refreshes the human-facing docs and completes the AGENTS.md index tables.

  • AGENTS.md: the Project Documentation table listed 4 of the 16 documents in
    agents-docs/, and the Skills table listed 5 of the 16 skills in
    .agents/skills/. Both are now complete, with descriptions taken from each
    skill's own frontmatter rather than paraphrased.
  • README.md: adds the Table of Contents that readme-best-practices requires
    for READMEs over 100 lines.
  • Tightens prose in README.md ("Linting clean" -> "Lint clean", and similar).

Split out

The brace-expansion override bump that was originally bundled here is now its
own 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.md is 108 lines, within the MAX_LINES_AGENTS_MD=150 limit.

@google-labs-jules

Copy link
Copy Markdown
Contributor

👋 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 @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

@vercel

vercel Bot commented Sep 30, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
do-web-doc-resolover Ready Ready Preview Oct 1, 2026 4:49pm UTC

@codacy-production

codacy-production Bot commented Sep 30, 2026 •

Copy link
Copy Markdown
Contributor

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@cline-cloud

cline-cloud Bot commented Oct 1, 2026

Copy link
Copy Markdown
Contributor

🔥 Roast: the best PR in the queue is filed under the wrong title

Credit where it is due — this is the only green PR here: 47 checks pass, MERGEABLE/CLEAN, and the docs edits are real improvements ("Linting clean" → "Lint clean", the table conversions, the tightened prose in README.md).

But it is filed as docs:, and its single most valuable change is not documentation at all.

The security fix hiding in a docs PR

   "overrides": {
-    "brace-expansion": "5.0.9",
+    "brace-expansion": "5.0.12",

main is currently pinned to brace-expansion@5.0.9, which is affected by three open advisories:

Advisory Severity Vulnerable range
GHSA-6j4f-fj2g-mc7p high >= 4.0.0, < 5.0.10
GHSA-qhr7-859c-m2p7 high >= 4.0.0, < 5.0.11
GHSA-q2hr-2g5m-vhwr medium >= 4.0.0, < 5.0.12

All three are DoS / stack-exhaustion issues, and 5.0.12 clears all three. So the repo is shipping a dependency with two high-severity DoS advisories, and the remediation is currently sitting inside a pull request titled "update human-facing docs".

This should be its own PR. The repo has a security scope in commitlint.config.cjs and a Dependency Audit job precisely so this gets reviewed as what it is. Bundled here, it is invisible to anyone scanning titles for security work — and if the docs edits need a round of review, the CVE fix waits behind them.

Now the roast

This 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. agents-docs/ contains 16:

ASSETS.md  CONFIG.md  DEPENDABOT_AUTO_MERGE_SOP.md  DEPLOYMENT.md  DEVELOPMENT.md
ISSUES.md  OVERVIEW.md  README.md  RELEASES.md  SEMANTIC_HEALTH.md
SEMANTIC_HEALTH_2026_06.md  SEMANTIC_HEALTH_AUG_2026.md
SEMANTIC_HEALTH_AUG_2026_SUMMARY.md  SEMANTIC_HEALTH_ISSUE.md
SEMANTIC_HEALTH_JULY_2026.md  semantic_health_summary.md

Missing: ASSETS, DEPLOYMENT, ISSUES, RELEASES, DEPENDABOT_AUTO_MERGE_SOP, the agents-docs/README.md index, and all six SEMANTIC_HEALTH archives. You built a table of contents and left out 75% of the library.

Skills table — lists 5 skills. .agents/skills/ contains 16:

agent-browser  anti-ai-slop  codacy  do-github-pr-sentinel  do-wdr-assets
do-wdr-cli  do-wdr-issue-impl  do-wdr-issue-swarm  do-wdr-release
do-wdr-ui-component  do-wdr-visual-resolver  do-web-doc-resolver
privacy-first  readme-best-practices  skill-creator  vercel-cli

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 — readme-best-practices lists this as a defect:

Missing Table of Contents on READMEs longer than 100 lines

README.md is 153 lines after this PR (up from 151), has 19 headings, and still has no Table of Contents. The PR refreshed the README in the name of the README skill and skipped the one rule in that skill that is purely mechanical and impossible to miss.

Verdict

Keep — genuinely useful, and the only PR that is actually mergeable.

Two asks:

  1. Split the brace-expansion bump into its own fix(security): PR so it can land independently and immediately.
  2. Either complete the two index tables or drop the "Description" column so they stop implying completeness.

d-oit added 2 commits October 1, 2026 16:22
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
@cline-cloud
cline-cloud Bot merged commit f170332 into main Oct 1, 2026
49 checks passed
@cline-cloud
cline-cloud Bot deleted the docs/update-docs-and-agents-workflow-13375211053076290983 branch October 1, 2026 16:58

This branch was successfully deployed

1 active deployment
Preview — aa45964a Deployed Oct 1, 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