Repository navigation
docs: fix stale markdown and drop the CLAUDE.md symlink - #2632
Merged
Merged
Conversation
Contributor
|
Claude Security Review: no high-confidence findings. (run) |
Contributor
There was a problem hiding this comment.
AgentCore Harness Review
Verdict: Looks good
Docs-only PR. I spot-checked each claim against the current source:
CLAUDE.mdsymlink removed and no remaining references in docs/workflows.- Workflow list in
.github/workflows/README.mdmatches the files on disk (canary.yml,prerelease.yml,pr-automation.yml,codeql.yml,slack-pr-review-notification.yml,workflow-metrics.yml,e2e-test.yml). CONTRIBUTING.mdpre-commit note matcheslint-staged(oxlint --fixthenprettier --write), andsrc/secrets/andsrc/cliVersionManager/exist.README.mdcommand table —logs,migratehandlers exist undersrc/handlers/.docs/china-regions.md—agent-python-strands-containeris a real shortcut insrc/handlers/project/shortcuts.ts.docs/harness-project-configuration.mdConnections section — grantType enum, outbound-auth union (awsIam/none/oauth),customParametersstring map, ARN prefixes,accessvalues,description200-char cap, andidregex all matchsrc/projectSchemas/connections.ts. The table's "ARN required/optional" column matches the schemas (memory/gateway/runtime required; browser/code-interpreter optional).agent-typescript-strands/README.md—load.tsdoes setclientConfig: { baseURL: ... }for OpenAI-compatible, so the new wording is accurate.
No issues worth blocking on. Good to merge.
jariy17
marked this pull request as ready for review
October 20, 2026 21:03
Audited every tracked .md against the code on `refactor`. - README.md: the top-level command is `logs`, not `log`; add the missing `migrate` command to the table. - docs/harness-project-configuration.md: document `connections`, a valid top-level harness.yaml field that had no coverage in any doc. - docs/china-regions.md: `agent-python-strands-container` also takes a `--model-provider` override, so it belongs in the LiteLLM template list. - .github/workflows/README.md: the hierarchy listed 4 of 11 workflows and omitted `e2e-test.yml`, which is a reusable job like `verify.yml`. - agent-typescript-strands/README.md: `--api-base` was removed from `create` (project.test.ts asserts it now errors); the base URL comes from the wizard and is baked into load.ts. - CONTRIBUTING.md: the pre-commit hook runs oxlint before Prettier, and the repo layout was missing `secrets/` and `cliVersionManager/`. Remove CLAUDE.md, a symlink to AGENTS.md, and the AGENTS.md line describing it. command.md regenerates byte-identical, so it is untouched.
jariy17
force-pushed
the
docs/refresh-stale-markdown
branch
from
October 20, 2026 21:52
cec29d4 to
c26b6de
Compare
Contributor
|
Claude Security Review: no high-confidence findings. (run) |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## refactor #2632 +/- ##
=========================================
Coverage 96.62% 96.62%
=========================================
Files 706 706
Lines 58460 58460
=========================================
Hits 56485 56485
Misses 1975 1975 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
notgitika
approved these changes
Oct 20, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Audited every tracked
.mdonrefactoragainst the code and fixed the six places that had drifted. Documentation only — no behavior changes.README.mdlog; the real top-level command islogs. Added the missingmigratecommand.docs/harness-project-configuration.mdconnectionsis a valid top-levelharness.yamlfield (HarnessSpecSchema→yamlFields) with memory / gateway / runtime / browser / codeInterpreter targets, and had zero coverage in any doc.docs/china-regions.mdagent-python-strands-containerto the LiteLLM template list — it also hassupportsModelProviderOverride: true, andREADME.mdalready listed it, so the two docs disagreed..github/workflows/README.mde2e-test.yml, a reusableworkflow_calljob consumed by bothci.ymlandcanary.yml.src/assets/templates/agent-typescript-strands/README.md--api-base, removed fromcreate(project.test.ts:517asserts it now errors). The base URL comes from the wizard and is baked intoload.tsasclientConfig.baseURL. This README ships in every scaffolded TypeScript Strands project.CONTRIBUTING.mdoxlint --fixbefore Prettier (AGENTS.mdhad this right). Repo layout was missingsecrets/andcliVersionManager/.Also removes
CLAUDE.md— a symlink toAGENTS.md— and theAGENTS.mdline that described it.command.mdregenerates byte-identical (202 commands), so it is untouched.Related Issue
Closes #2631
Documentation PR
Not applicable — this PR is the documentation change.
Type of Change
Testing
bun test— 4705 pass, 0 fail, 311 filesbun run test:e2e, or explained why they are not applicable — not applicable, no runtime behavior changesbun run typecheckbun run lint:checkbun run format:checkbun run buildsrc/assets/, I updated affected snapshots withbun test <test-file> --update-snapshotsand committed them — no snapshot changes needed;src/core/project/templates/andsrc/handlers/project/add/runtime/pass unchanged (171 tests)Also verified
bun scripts/generate-command-reference.mjsproduces no diff.Checklist
Note for reviewers
Issue #2631 also records a related code problem left out of this PR:
src/core/project/manager.tsx(~lines 175, 197, 202, 316, 1629) tells users to re-run with--model-provider/--api-base, flags that no longer exist oncreate. Following those error messages yieldsunknown option. Happy to fix in a follow-up.