mirror of
https://github.com/morluto/rea.git
synced 2026-11-05 06:45:22 +00:00
[GH-ISSUE #649] [Docs] README, AGENTS.md, and docs/testing.md still describe the removed TypeDoc API docs pipeline #308
Closed
opened 2026-10-15 18:23:43 +00:00 by bsakaguchi
·
0 comments
No Branch/Tag specified
main
codex/procedure-reference-stacked
release-please--branches--main--components--rea-agents
release-please--branches--main--components--rea-agents--release-notes
codex/kuna-independent-retry
codex/byte-search-overlay-coverage
codex/open-failure-target-receipt
codex/kuna-xref-evidence
codex/ghidra-ambiguous-procedure-recovery
codex/function-source-bundle
codex/trace-function-integration-prototype
codex/snapshot-source-closure
codex/recorded-evidence-array-pages
codex/evidence-recovery-redesign
codex/trace-feature-address-scope
codex/call-discovery-scope
codex/ghidra-literal-candidate-evidence
codex/decompile-directory-independent-retry
codex/retry-provenance-base
codex/value-flow-capability-experiment
codex/ghidra-containing-instruction
cursor/readme-discord-button-ef9f
dependabot/github_actions/actions/setup-node-7.1.0
dependabot/github_actions/actions/upload-artifact-7.0.2
dependabot/npm_and_yarn/npm-minor-and-patch-d8d97ce6df
codex/kuna-1989
fix/8559-native-ui-fixture-ownership
fix/8555-go-verifier-mcp-ownership
codex/provider-capability-recovery
fix/8642-rizin-target-stdin
codex/ghidra-memory-effect-scope
codex/ghidra-annotation-entry-selector
codex/ghidra-readonly-recovery
codex/ghidra-regex-verifier-recovery
codex/evidence-discovery-view-guidance
fix/8545-bulk-append-overflow
fix/8428-navigation-refusal-alternatives
codex/address-context-recovery
codex/matching-member-limitations
codex/unknown-scope-contract
codex/evidence-view-guidance
feat/8373-native-trace-views
codex/ghidra-snapshot-verifier-binding
codex/elf-export-visibility
codex/evidence-view-recovery
codex/native-reference-cli-help
codex/provider-candidate-observation-scope
codex/kuna-session-verification
codex/ghidra-switch-lifetime-guidance
codex/pseudocode-paging-discovery
codex/clarify-evidence-view-support
codex/kuna-xrefs-selector-recovery
codex/context-capacity-recovery
codex/evidence-closure-large-links
codex/same-function-evidence-identity
codex/ghidra-verifier-inspected-jdk
codex/audit-guided-workflows
codex/crash-prompt-retained-dossiers
codex/analysis-view-error-recovery
codex/kuna-verifier-target-selection
codex/ghidra-selected-project-call-coverage
codex/docs-native-analysis-scope
codex/ghidra-java-socket-boundary
codex/ghidra-retained-snapshot-verifier
codex/ghidra-search-inventory-facts
fix/8284-zero-argument-parameter-bindings
fix/8198-ui-action-handler-offset
fix/8257-elf-entry-label-identity
fix/8304-deferred-output-schema-projection
fix/8277-call-path-computed-target-uncertainty
fix/pr-8089-conflicts
fix/ci-static-duplicate-export
dependabot/npm_and_yarn/lint-staged-17.6.0
dependabot/github_actions/actions/download-artifact-8.0.2
dependabot/npm_and_yarn/write-file-atomic-8.0.0
dependabot/npm_and_yarn/canonicalize-5.1.0
dependabot/github_actions/actions/cache/restore-6.1.0
dependabot/npm_and_yarn/toon-format/toon-4.4.0
dependabot/github_actions/actions/deploy-pages-5.0.1
codex/review-fixes-pr-2403
codex/review-fixes-pr-2400
codex/process-terminal-width
codex/test-brittleness-cleanup
verify/7167-browser-connect-macos
fix/7167-browser-connect
feat/native-matching-allowance-setting
feat/browser-scenario-dry-run
test/managed-caller-parameters-20261024
codex/parser-fortythird-boundaries
fix/6926-pinvoke-platform-decorations-20261023
fix/6889-har-body-encoding-20261023
fix/6888-sqlite-schema-budget-20261023
fix/dependency-security-gates-6708
cursor/evidence-overwrite-rebase-b4ac
feat/4057-verify-native-exports
fix/windows-acl-observer-overhead-20261022
cursor/erlang-beam-restack-4476
cursor/pe-certificate-review-bf32
fix/6116-javascript-application-fs-errors
fix/6061-unmapped-runtime-script-unknown
feat/browser-scenario-summary
fix/pe-certificates
codex/verify-3407
cursor/rebase-5699
cursor/rebase-5352
cursor/rebase-5600
cursor/fix-cli-schema-omission-10a8
codex/audit-hopper-shutdown-reasons-20261021
fix/demangle-swift-omitted-record
fix/nib-boolean-value-types
cursor/cancellation-partial-observation-a5ac
fix/ib-object-limit-reasons
fix/electron-fuse-limit-advice
fix/kuna-doctor-dangling-cache
fix/fixed-budget-refusal-advice
fix/js-ipc-listener-dedup
fix/js-return-member-provenance
fix/dmg-integrity-retry-advice
fix/ida-doctor-readiness
fix/kuna-version-probe-output-drain
fix/legacy-swift-runtime-name-matching
fix/dylib-lazy-load-commands
fix/browser-scenario-startup-cancel
fix/swift-nested-punycode-classification
fix/compare-unselected-scopes
fix/objc-method-budget-coverage
fix/dmg-mounted-root-observations
audit/ci-tests-20261019-round2
release/6.7.0
fix/wabt-cleanup-retry-resolution
fix/electron-fuse-elf-pe-architecture
fix/native-plist-descriptor-ownership
fix/kuna-caller-cleanup-ownership
experiment/atomic-codemode-20261016
review/first-contributor-3776
fix/call-resolution-full-read-cycles
fix/member-mutation-selection-repeat
experiment/atomic-re-tools-20261015
perf/member-mutation-lazy-origins
perf/static-network-mutation-index
fix/hopper-startup-lifecycle
audit/3050-windows-proof-20261015
feat/windows-window-capture-2183
audit/3049-windows-proof-20261015
audit/3735-macos-fixtures-20261015
fix/batch-decompile-null-pseudocode
fix/kuna-inventory-honors-jobs
experiment/browser-codemode-tool-design-20261015
fix/hopper-clean-runtime-argv
codex/review-2049-27f1b367
review-fixes/pr-2787-routing
fix/3360-scoped-this-emitters
fix/3367-replaced-global-effects
fix/3838-compact-any-value-items
test/hopper-download-probe-20261015
codex/windows-runtime-creation-red-green-20261015
codex/windows-readonly-root-red-green-20261015
codex/windows-root-share-red-green-20261015
codex/exp-1685-win-mcp-startup
codex/bug-sweep-20261015
investigate/2190-windows-package-phases
investigate/3543-macos-cli-deadline
perf/3281-reverse-tools-feedback-quality
fix/3406-hopper-doctor-fixture
fix/3341-wrapper-require-test-context
fix/3301-owned-uninstall-fixtures
fix/3164-compiler-input-ownership
fix/pcap-cleanup-stdout-newline-20261014
perf/interface-builder-summary
codex/review-fixes-pr-1977
fix/ghidra-effective-jvm-platform
fix/docs-turkish-rust-link-20261013
fix/main-maintenance-ci-20261010
fix/recover-binary-session-process-effects
codex/review-fixes-pr-2457
codex/ci-required-cancellation-gate
fix/main-format-baseline-20261013
fix/setup-preserve-entry-fields
cursor/restore-main-checks-1ffc
fix/ghidra-bridge-hashmap-import
codex/shared-ci-jadx-json-default-20261013
codex/shared-ci-ghidra-test-groups-20261013
codex/shared-ci-java-fixture-format-20261013
codex/fix-intrinsic-invocation-boundaries
test/release-preflight-reusable-jobs
test/js-parameter-provenance-expectation
fix/linux-hopper-verification-current
test/2419-ghidra-elf-probe-size
followup/pr-1544-native-ida
codex/fold-pr-2230-contribution
docs/readme-responsible-use
fix/issue-2064
fix/issue-2050
fix/issue-2053
fix/issue-1968
fix/issue-1945
experiment/codemode-bridge-20261011
fix/tool-effects-negative-wording-1904-20261012
fix/1842-electron-interop-provenance
feat/recover-javascript-multi-input
refactor/website-i18n-prep
fix/nativeaot-pe-virtual-extent
fix/browser-verifier-ci-hang
fix/pe-resources-input-selection
docs/beginner-friendly-guides
docs/beginner-setup-guide
fix/javascript-analysis-worker-1563
fix/1649-ghidra-duplicate-names
fix/javascript-export-keys-integration-1369
test/maintenance-boundary-contracts-20261011
review/javascript-export-keys-1369
review/process-live-progress-1483
test/javascript-1495-growth-ratio
fix/ci-escape-timing
docs/normalized-terminal-geometry-1450
release/6.3.0
archive/release-6.3.0-pr1381
release/6.2.0
fix/electron-preload-dynamic-override
fix/javascript-self-referential-bundler-edges
release/6.1.0
cursor/grok-client-cherry-pick-0b56
feat/signature-posture
feat/dyld-shared-cache
feat/artifact-integrity-policy
feat/pkg-inventory
release/6.0.0
chore/sync-release-5.0.0
release/5.0.0
cursor/cloud-agent-node-787e
fix/javascript-xhr-open-endpoints
review/pr-711-realpath-fallback-wording
cleanup/replay-confinement
codex/test-suite-performance
codex/issue-foundations
codex/address-open-issues-2026-07-20
agent/javascript-vite-rollup-esbuild-adapters
agent/process-cleanup
agent/triage-integration
agent/unknown-commands-registry
feat/mcp-identity-metadata
morlvps/issue_cleanup
codex/installer-redesign
morl/roadmap-investigation-core
morl/roadmap-investigation-docs
release-please--branches--main--components--rea
rea-agents-6.8.0
rea-agents-6.7.0
rea-agents-6.6.0
experiment/atomic-codemode-wait-runtime-20261016
rea-agents-6.5.0
rea-agents-6.4.0
rea-agents-6.3.0
rea-agents-6.2.0
rea-agents-6.1.0
rea-agents-6.0.0
rea-agents-5.0.0
rea-agents-4.1.0
rea-agents-4.0.1
rea-agents-4.0.0
rea-agents-3.2.1
rea-agents-3.2.0
rea-agents-3.1.0
rea-agents-3.0.0
rea-agents-2.7.0
rea-agents-2.6.0
rea-agents-2.5.1
rea-agents-2.5.0
rea-agents-2.4.0
rea-agents-2.3.0
rea-agents-2.2.0
rea-agents-2.1.0
rea-agents-2.0.0
rea-agents-1.7.0
rea-agents-1.6.0
rea-agents-1.5.0
rea-agents-1.4.0
rea-agents-1.3.0
rea-agents-1.2.0
rea-agents-1.1.0
rea-agents-1.0.0
rea-agents-0.5.0
rea-agents-0.4.0
rea-agents-0.3.0
rea-0.2.1
rea-0.2.0
Labels
Clear labels
area: bridge
area: bridge
area: build
area: build
area: build
area: cli
area: domain
area: evidence
area: mcp
area: native
area: providers
area: runtime
area: server
area: setup
area: tests
bug
design
documentation
enhancement
enhancement
enhancement
experiment
help wanted
i18n
invalid
P0: critical
P1: high
P2: medium
P2: medium
P2: medium
P3: low
performance
provider-request
pull-request
Mirrored from GitHub Pull Request
question
roadmap
triage
No labels
area: bridge
area: bridge
area: build
area: build
area: build
area: cli
area: domain
area: evidence
area: mcp
area: native
area: providers
area: runtime
area: server
area: setup
area: tests
bug
design
documentation
enhancement
enhancement
enhancement
experiment
help wanted
i18n
invalid
P0: critical
P1: high
P2: medium
P2: medium
P2: medium
P3: low
performance
provider-request
pull-request
question
roadmap
triage
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".
No due date set.
Dependencies
No dependencies set.
Reference
morluto/rea#308
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @coygeek on GitHub (Oct 6, 2026).
Original GitHub issue: https://github.com/morluto/rea/issues/649
Summary
The commit "chore(deps): remove incompatible TypeDoc generator" removed the
docs:apianddocs:api:cachedscripts, thedocs:apiTurbo task,typedoc.json, and the CI step that uploaded theapi-docsartifact, and it updatedCONTRIBUTING.mdand removed thedocs:api:cachedrow from thedocs/testing.mdcommand table. The follow-up pull request #644 added a conformance test that asserts the removal. Four statements onmainstill describe the removed pipeline: two inREADME.md, one inAGENTS.md, and one indocs/testing.md. A contributor or coding agent who followsAGENTS.mdand runsnpm run docs:api:cachedgets a missing-script error, and readers ofREADME.mdare told that PR CI renders TypeDoc and publishes anapi-docsartifact, which it no longer does.Affected area
README.md:385: "PR CI verifies this catalog, narrative documentation, generated schemas, and a clean TypeDoc render."README.md:654: "PR CI publishes generated API documentation as theapi-docsartifact."AGENTS.md:38: "npm run docs:check: check committed generated documents;npm run docs:api:cachedseparately renders API HTML when needed."docs/testing.md:232-233: "TypeDoc rendering is a separate command and CI step."docs/testing.md:185: thenpm run docs:checkrow says "Committed generated-document freshness, without API HTML rendering". At 4.0.1 this contrasted with the next row,npm run docs:api:cached("Explicit cached API HTML rendering"), which the removal deleted. The qualifier is not false by itself, but it now points at a rendering path that no longer exists.Runtime or environment
mainat19f8cddfd6, fresh clone.965d0b35f9.rea-agents4.0.1 (tagrea-agents-4.0.1,feeb19b8b3), which predates the removal.CONTRIBUTING.mdasks contributors to use; the result below comes from npm's script lookup inpackage.jsonand needs no installed dependencies.Steps to reproduce
mainbaseline above.npm run docs:api:cachedandnpm run docs:apiin the clone root.grep -rn -i 'typedoc\|api-docs\|docs:api\|api html' --exclude-dir=node_modules --exclude-dir=.git . | grep -v package-lock.e4bf5048):gh api repos/morluto/rea/actions/runs/37412309539/artifacts --jq '.artifacts[].name'. Then list the steps of its "Docs Generation" job.Expected behavior
After the removal commit, the documentation should describe only the documentation checks that exist.
CONTRIBUTING.mdonmainalready does this: "docs:checkchecks committed generated metadata.docs:generateregenerates those files, and the docs CI lane checks them." The conformance testtests/conformance/releaseConfiguration.test.ts("keeps generated API HTML out of the tracked tree") asserts thattypedoc.jsonis absent and thatpackage.jsonhas nodocs:apiscript, so the removal is intentional.README.md,AGENTS.md, anddocs/testing.mdshould therefore not claim that PR CI performs a TypeDoc render, that it publishes anapi-docsartifact, or thatnpm run docs:api:cachedrenders API HTML.Actual behavior
All four statements and the qualifier are present verbatim on
main. Running the script named inAGENTS.mdfails. Each command also printed a final line pointing at npm's local debug log; that line is omitted below.On
main,npm runlistsdocs:generate,docs:generate:unlocked,docs:check,docs:check:built, anddocs:error-schema, but nodocs:api*script.turbo.jsonhas nodocs:apitask, and.github/workflows/ci.ymlhas nodocs:api:cachedstep and noapi-docsupload. The PR CI run 37412309539 uploaded eight artifacts:vitest-report-0throughvitest-report-3,rea-dist,reconstruction-readiness,windows-capabilities, andtest-results. None of them isapi-docs. Its "Docs Generation" job ran onlynpm ciandnpm run docs:checkbetween setup and teardown. The grep in step 4 finds no other matches besides the four stale statements, thedocs/testing.md:185qualifier, the conformance test above, and historicalCHANGELOG.mdentries.Evidence
CONTRIBUTING.md:55-56andtests/conformance/releaseConfiguration.test.ts:104-112onmain, plus the removal commit's diff ofpackage.json,turbo.json,typedoc.json, and.github/workflows/ci.yml.README.md:385,README.md:654,AGENTS.md:38, anddocs/testing.md:232-233(with the related qualifier atdocs/testing.md:185) onmain, with thenpm run docs:api:cachedoutput and the CI run 37412309539 artifact list shown under Actual behavior.The evidence above comes from a fresh clone, local
npm run, and read-only GitHub API queries for the CI run. The removal commit deleted exactly the scripts, Turbo task, config file, and CI upload step that these four statements describe. At the 4.0.1 tag the scriptsdocs:api(typedoc) anddocs:api:cached(turbo run docs:api), thedocs:apiTurbo task,typedoc.json, and the CI upload ofbuild/api-docsasapi-docsall exist, so the same four statements were accurate for the 4.0.1 release. This report concernsmainonly.README.mdis in the packagefileslist, and the open release pull request #635 for 4.0.2 does not change these lines, so the next npm release would carry the staleREADME.mdstatements unless they are corrected first.Restoration check
On
main,README.md,AGENTS.md, anddocs/testing.mdno longer state or imply that PR CI performs a TypeDoc render, publishes anapi-docsartifact, or thatnpm run docs:api:cached(ordocs:api) renders API HTML. Any documentation command a reader is told to run exists inpackage.json. Repeating the grep in step 4 returns no matches inREADME.md,AGENTS.md, ordocs/testing.mdthat describe TypeDoc, anapi-docsartifact, or adocs:api*command; the remaining matches are historicalCHANGELOG.mdentries, the conformance test that asserts the removal, and at most a rewordeddocs/testing.md:185row that no longer implies a separate API HTML rendering command. As a control, the existing conformance test that asserts the absence oftypedoc.jsonand thedocs:apiscript still passes. A wording change that only renames the missing command, or one that reintroduces a TypeDoc step without a working script and CI step, does not restore the contract.Additional context
Issue #643 ("docs:api broken under TypeScript 7 (typedoc incompatible)") led to the removal and was closed with a comment that "related docs were removed." The removal commit updated
CONTRIBUTING.mdand thedocs/testing.mdcommand table but not the four statements above. The translated READMEs (README_ar.md,README_ja.md,README_ko.md,README_zh.md) contain noTypeDoc,api-docs, ordocs:apistring.Triage assessment
npm run docs:api:cachedfails immediately with a clear missing-script error, and the README claims about PR CI only misdescribe contributor tooling. The effect is limited to contributors and coding agents who readAGENTS.md,README.md, ordocs/testing.md.CONTRIBUTING.mdonmaincorrectly describesdocs:checkanddocs:generateas the documentation checks, andnpm runlists the scripts that exist. No API HTML rendering exists to preserve.