[PR #6383] docs: repair dead anchors and unambiguous documentation errors #7324

Open
opened 2026-11-01 21:47:02 +00:00 by bsakaguchi · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/6383
Author: @ashyyhere
Created: 10/22/2026
Status: 🔄 Open

Base: main ← Head: docs/fix-doc-typos-and-dead-anchors


📝 Commits (1)

  • 7ac6d9b test(conformance): guard Malayalam heading links against joiner loss

📊 Changes

1 file changed (+21 additions, -0 deletions)

View changed files

📝 tests/conformance/readmeConsistency.test.ts (+21 -0)

📄 Description

Summary

Three same-file links in the Malayalam README point at English anchor names the translation no longer defines, so clicking them on GitHub does nothing. This PR repoints them at GitHub's real rendered heading ids, repairs the unambiguous documentation errors found in the same full-repository sweep, and adds a conformance case that keeps the Malayalam anchor forms — including the U+200C the rendered ids retain — from silently regressing.

Fixes #6731

Problem and expected behavior

  • docs/readme/README_ml.md links three of its own sections by their former English names (#showcases at line 250, #update-rea at line 278, and the badge link #what-you-can-analyze at line 14); none of the three anchors exists in the file.
  • docs/il2cpp-metadata.md merged words into run-together tokens (bounded to1GiB, limited to65,536, a64MiB, exact64-bit, characters,32MiB file,1,000,000).
  • docs/windows-ghidra-p0.md dropped a predicate ("Caller priority is preserved, and caller CPU affinity whenever...").
  • docs/browser-observation.md began a paragraph and three sentences in lowercase.
  • docs/installation.md said "the former remains the diagnostic fallback" after a four-item list with no pair to refer to.
  • docs/agent-environments.md used nonstandard "another origin than"; docs/releasing.md had an h3 under the h1 where every sibling section is h2; docs/testing.md ended a bullet without terminal punctuation.
  • Four files (docs/apple-application-analysis.md, docs/process-capture.md, website/README.md, website/figures.md) used a stray Unicode right single quote where the rest of each file uses ASCII apostrophes.

Change and scope

Documentation-only prose and link targets, plus one conformance test. No code, contract, or generated-metadata changes.

The three Malayalam anchors now target the localized headings, taken from GitHub's rendered user-content- heading ids rather than a recomputed slug: GitHub retains U+200C in ids such as #rea-അപ്‌ഡേറ്റ്-ചെയ്യുക, which the npm github-slugger package strips. For the same reason README_fa.md is correct as-is and is untouched.

Commit 6807f08 extends tests/conformance/readmeConsistency.test.ts with a Malayalam case mirroring the existing Persian one, writing the fragile joiner as an explicit \u200c escape so an editor cannot strip it invisibly. This addresses the P2 review finding on this PR; the test was verified to fail when the joiner is removed from README_ml.md.

Follow the contribution scope. Not applicable: no new provider or capability; no target execution, injection, mutation, or protection recovery.

Contract and boundary impact

  • Semantic owner and earliest changed stage: documentation prose and rendered link targets only.
  • Contribution scope fit and linked maintainer decision: ordinary docs fix within existing boundaries; not applicable.
  • CLI and MCP/tool-catalog contract: none.
  • Provider, bridge, target-format, or platform compatibility: none.
  • Evidence, artifact, provenance, or reconstruction contract: none.
  • Target selection, authority, upstream behavior, and cleanup details: not applicable.
  • Generated metadata (docs/public/product-catalog.json), package, or installation impact: none; no generated files touched.

Expected effects (check known effects; use documentation-only on its own).

  • Read existing files or captured data.
  • Launch or attach to a process.
  • Inject instrumentation or run scripts/code.
  • Change process memory, registers, files, or configuration.
  • Contact network services.
  • Recover protected code or work around protections.
  • Documentation or usability only; no target interaction.
  • Not sure yet; investigation or maintainer guidance needed.

Evidence and regression coverage

  • Tests added or updated: tests/conformance/readmeConsistency.test.ts gains a Malayalam case covering all three repaired heading/fragment pairs, including the U+200C joiner, mirroring the existing Persian coverage. Negative check: with the joiner stripped from README_ml.md, the test fails (guard verified); with the branch applied, it passes 10/10.
  • Base reproduction or other evidence: executed. On the base revision each of the three anchors is absent from the file's rendered heading ids (verified against GitHub's rendered user-content- ids of docs/readme/README_ml.md on main); after the change every same-file anchor in the file resolves.
  • Remaining proof gaps: anchors were verified against the current GitHub render of main, not a local VitePress build of the translated page.

For evidence-bearing changes:

  • Observed, derived, and inferred claims remain distinguishable.
  • Artifact identity, source provenance, and failed attempts remain preserved.
  • Unsupported, incomplete, unavailable, or uncertain outcomes remain visible.

Validation performed

  • npm run docs:check — passed on this branch (6/6 turbo tasks; tests/conformance/readmeConsistency.test.ts 10/10).
  • Full-repo markdown link/anchor crawl after the change — no unresolved same-file anchors remain; remaining hits reviewed and confirmed false positives (U+200C forms that GitHub renders correctly) or pre-existing generated-file links.

Compatibility, safety, and release

  • Breaking changes or migration steps: none.
  • Real Hopper/Ghidra, browser, or OS coverage: not applicable; docs-only.
  • Package or release metadata impact: none.
  • Security, privacy, process, or containment review: none.

Author readiness

Human owner: @ashyyhere

  • I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work.
  • I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps.
  • I declare this PR ready for initial maintainer review.

Before merge

  • This PR addresses a concrete problem or an agreed enhancement.
  • Material scope and authority questions are resolved, and any required maintainer scope decision covers the final diff.
  • The PR has one focused outcome and the title follows type(scope): outcome.
  • Related issue is linked, or the reason for not linking one is stated above.
  • Tests cover changed observable behavior and meaningful failure paths.
  • Owning docs, contracts, and generated metadata are updated where needed.
  • User-visible CLI/MCP changes include representative output.
  • I checked the final diff for secrets, unrelated cleanup, and unsupported claims.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/morluto/rea/pull/6383 **Author:** [@ashyyhere](https://github.com/ashyyhere) **Created:** 10/22/2026 **Status:** 🔄 Open **Base:** `main` ← **Head:** `docs/fix-doc-typos-and-dead-anchors` --- ### 📝 Commits (1) - [`7ac6d9b`](https://github.com/morluto/rea/commit/7ac6d9be076f608fc98da710cc4041ad13b4a257) test(conformance): guard Malayalam heading links against joiner loss ### 📊 Changes **1 file changed** (+21 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `tests/conformance/readmeConsistency.test.ts` (+21 -0) </details> ### 📄 Description ## Summary Three same-file links in the Malayalam README point at English anchor names the translation no longer defines, so clicking them on GitHub does nothing. This PR repoints them at GitHub's real rendered heading ids, repairs the unambiguous documentation errors found in the same full-repository sweep, and adds a conformance case that keeps the Malayalam anchor forms — including the U+200C the rendered ids retain — from silently regressing. Fixes #6731 ## Problem and expected behavior - `docs/readme/README_ml.md` links three of its own sections by their former English names (`#showcases` at line 250, `#update-rea` at line 278, and the badge link `#what-you-can-analyze` at line 14); none of the three anchors exists in the file. - `docs/il2cpp-metadata.md` merged words into run-together tokens (`bounded to1GiB`, `limited to65,536`, `a64MiB`, `exact64-bit`, `characters,32MiB file,1,000,000`). - `docs/windows-ghidra-p0.md` dropped a predicate ("Caller priority is preserved, and caller CPU affinity whenever..."). - `docs/browser-observation.md` began a paragraph and three sentences in lowercase. - `docs/installation.md` said "the former remains the diagnostic fallback" after a four-item list with no pair to refer to. - `docs/agent-environments.md` used nonstandard "another origin than"; `docs/releasing.md` had an `h3` under the `h1` where every sibling section is `h2`; `docs/testing.md` ended a bullet without terminal punctuation. - Four files (`docs/apple-application-analysis.md`, `docs/process-capture.md`, `website/README.md`, `website/figures.md`) used a stray Unicode right single quote where the rest of each file uses ASCII apostrophes. ## Change and scope Documentation-only prose and link targets, plus one conformance test. No code, contract, or generated-metadata changes. The three Malayalam anchors now target the localized headings, taken from GitHub's rendered `user-content-` heading ids rather than a recomputed slug: GitHub retains U+200C in ids such as `#rea-അപ്‌ഡേറ്റ്-ചെയ്യുക`, which the npm `github-slugger` package strips. For the same reason `README_fa.md` is correct as-is and is untouched. Commit `6807f08` extends `tests/conformance/readmeConsistency.test.ts` with a Malayalam case mirroring the existing Persian one, writing the fragile joiner as an explicit `\u200c` escape so an editor cannot strip it invisibly. This addresses the P2 review finding on this PR; the test was verified to fail when the joiner is removed from `README_ml.md`. Follow the [contribution scope](https://github.com/morluto/rea/blob/main/CONTRIBUTING.md#contribution-scope). Not applicable: no new provider or capability; no target execution, injection, mutation, or protection recovery. ## Contract and boundary impact - Semantic owner and earliest changed stage: documentation prose and rendered link targets only. - Contribution scope fit and linked maintainer decision: ordinary docs fix within existing boundaries; not applicable. - CLI and MCP/tool-catalog contract: none. - Provider, bridge, target-format, or platform compatibility: none. - Evidence, artifact, provenance, or reconstruction contract: none. - Target selection, authority, upstream behavior, and cleanup details: not applicable. - Generated metadata (`docs/public/product-catalog.json`), package, or installation impact: none; no generated files touched. Expected effects (check known effects; use documentation-only on its own). - [x] Read existing files or captured data. - [ ] Launch or attach to a process. - [ ] Inject instrumentation or run scripts/code. - [ ] Change process memory, registers, files, or configuration. - [ ] Contact network services. - [ ] Recover protected code or work around protections. - [x] Documentation or usability only; no target interaction. - [ ] Not sure yet; investigation or maintainer guidance needed. ## Evidence and regression coverage - Tests added or updated: `tests/conformance/readmeConsistency.test.ts` gains a Malayalam case covering all three repaired heading/fragment pairs, including the U+200C joiner, mirroring the existing Persian coverage. Negative check: with the joiner stripped from `README_ml.md`, the test fails (guard verified); with the branch applied, it passes 10/10. - Base reproduction or other evidence: executed. On the base revision each of the three anchors is absent from the file's rendered heading ids (verified against GitHub's rendered `user-content-` ids of `docs/readme/README_ml.md` on `main`); after the change every same-file anchor in the file resolves. - Remaining proof gaps: anchors were verified against the current GitHub render of `main`, not a local VitePress build of the translated page. For evidence-bearing changes: - [x] Observed, derived, and inferred claims remain distinguishable. - [x] Artifact identity, source provenance, and failed attempts remain preserved. - [x] Unsupported, incomplete, unavailable, or uncertain outcomes remain visible. ## Validation performed - `npm run docs:check` — passed on this branch (6/6 turbo tasks; `tests/conformance/readmeConsistency.test.ts` 10/10). - Full-repo markdown link/anchor crawl after the change — no unresolved same-file anchors remain; remaining hits reviewed and confirmed false positives (U+200C forms that GitHub renders correctly) or pre-existing generated-file links. ## Compatibility, safety, and release - Breaking changes or migration steps: none. - Real Hopper/Ghidra, browser, or OS coverage: not applicable; docs-only. - Package or release metadata impact: none. - Security, privacy, process, or containment review: none. ## Author readiness Human owner: @ashyyhere - [x] I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work. - [x] I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps. - [x] I declare this PR ready for initial maintainer review. ## Before merge - [x] This PR addresses a concrete problem or an agreed enhancement. - [x] Material scope and authority questions are resolved, and any required maintainer scope decision covers the final diff. - [x] The PR has one focused outcome and the title follows `type(scope): outcome`. - [x] Related issue is linked, or the reason for not linking one is stated above. - [x] Tests cover changed observable behavior and meaningful failure paths. - [x] Owning docs, contracts, and generated metadata are updated where needed. - [ ] User-visible CLI/MCP changes include representative output. - [x] I checked the final diff for secrets, unrelated cleanup, and unsupported claims. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
Sign in to join this conversation.
No milestone
No project
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#7324
No description provided.