Skip to content

docs: fix stale markdown and drop the CLAUDE.md symlink - #2632

Merged
jariy17 merged 1 commit into
aws:refactorfrom
jariy17:docs/refresh-stale-markdown
Oct 20, 2026
Merged

jariy17 merged 1 commit into
aws:refactorfrom
jariy17:docs/refresh-stale-markdown

Conversation

@jariy17

@jariy17 jariy17 commented Oct 20, 2026

Copy link
Copy Markdown
Contributor

Description

Audited every tracked .md on refactor against the code and fixed the six places that had drifted. Documentation only — no behavior changes.

File Change
README.md Command table said log; the real top-level command is logs. Added the missing migrate command.
docs/harness-project-configuration.md New Connections section. connections is a valid top-level harness.yaml field (HarnessSpecSchema → yamlFields) with memory / gateway / runtime / browser / codeInterpreter targets, and had zero coverage in any doc.
docs/china-regions.md Added agent-python-strands-container to the LiteLLM template list — it also has supportsModelProviderOverride: true, and README.md already listed it, so the two docs disagreed.
.github/workflows/README.md The hierarchy listed 4 of 11 workflows and omitted e2e-test.yml, a reusable workflow_call job consumed by both ci.yml and canary.yml.
src/assets/templates/agent-typescript-strands/README.md Dropped the reference to --api-base, removed from create (project.test.ts:517 asserts it now errors). The base URL comes from the wizard and is baked into load.ts as clientConfig.baseURL. This README ships in every scaffolded TypeScript Strands project.
CONTRIBUTING.md Pre-commit hook runs oxlint --fix before Prettier (AGENTS.md had this right). Repo layout was missing secrets/ and cliVersionManager/.

Also removes CLAUDE.md — a symlink to AGENTS.md — and the AGENTS.md line that described it.

command.md regenerates 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

  • Documentation update

Testing

  • I ran bun test — 4705 pass, 0 fail, 311 files
  • I ran the relevant end-to-end tests with bun run test:e2e, or explained why they are not applicable — not applicable, no runtime behavior changes
  • I ran bun run typecheck
  • I ran bun run lint:check
  • I ran bun run format:check
  • I ran bun run build
  • If I modified src/assets/, I updated affected snapshots with bun test <test-file> --update-snapshots and committed them — no snapshot changes needed; src/core/project/templates/ and src/handlers/project/add/runtime/ pass unchanged (171 tests)

Also verified bun scripts/generate-command-reference.mjs produces no diff.

Checklist

  • I have read the CONTRIBUTING document
  • I have added any necessary tests that prove my fix is effective or my feature works — docs-only; no test surface
  • I have updated the documentation accordingly
  • I have added an appropriate example to the documentation to outline the feature, or no new docs are needed
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

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 on create. Following those error messages yields unknown option. Happy to fix in a follow-up.

@github-actions github-actions Bot added the size/m PR size: M label Oct 20, 2026
@agentcore-devx-automation agentcore-devx-automation Bot added agentcore-harness-reviewing AgentCore Harness review in progress claude-security-reviewing Claude Code /security-review in progress labels Oct 20, 2026
@agentcore-devx-automation

Copy link
Copy Markdown
Contributor

Claude Security Review: no high-confidence findings. (run)

@agentcore-devx-automation agentcore-devx-automation Bot removed claude-security-reviewing Claude Code /security-review in progress agentcore-harness-reviewing AgentCore Harness review in progress labels Oct 20, 2026

@agentcore-devx-automation agentcore-devx-automation Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AgentCore Harness Review

Verdict: Looks good

Docs-only PR. I spot-checked each claim against the current source:

  • CLAUDE.md symlink removed and no remaining references in docs/workflows.
  • Workflow list in .github/workflows/README.md matches 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.md pre-commit note matches lint-staged (oxlint --fix then prettier --write), and src/secrets/ and src/cliVersionManager/ exist.
  • README.md command table — logs, migrate handlers exist under src/handlers/.
  • docs/china-regions.md — agent-python-strands-container is a real shortcut in src/handlers/project/shortcuts.ts.
  • docs/harness-project-configuration.md Connections section — grantType enum, outbound-auth union (awsIam / none / oauth), customParameters string map, ARN prefixes, access values, description 200-char cap, and id regex all match src/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.ts does set clientConfig: { baseURL: ... } for OpenAI-compatible, so the new wording is accurate.

No issues worth blocking on. Good to merge.

@jariy17
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
jariy17 force-pushed the docs/refresh-stale-markdown branch from cec29d4 to c26b6de Compare October 20, 2026 21:52
@github-actions github-actions Bot added size/m PR size: M and removed size/m PR size: M labels Oct 20, 2026
@agentcore-devx-automation agentcore-devx-automation Bot added the claude-security-reviewing Claude Code /security-review in progress label Oct 20, 2026
@agentcore-devx-automation

Copy link
Copy Markdown
Contributor

Claude Security Review: no high-confidence findings. (run)

@agentcore-devx-automation agentcore-devx-automation Bot removed the claude-security-reviewing Claude Code /security-review in progress label Oct 20, 2026
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.62%. Comparing base (73e0f82) to head (c26b6de).

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@jariy17
jariy17 merged commit 6d86a4c into aws:refactor Oct 20, 2026
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/m PR size: M

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants