Files
reverse-engineering-anything/docs/specs/documentation/organization/plan.md
T
a67525cdf1 docs: organize canonical documentation layout and verify new pages (#2791)
* docs: organize canonical documentation layout (URGENTE)

Group all existing authored guides by domain and ownership, expose complete navigation, and preserve their public routes. Update physical path consumers and release configuration while retaining historical records. Document domain-based specs and ADR slugs without global numbering.

Co-Authored-By: Codex <noreply@openai.com>

* fix(docs): honor home layout in all-page route verification

* style: format reviewed source changes

* fix(docs): preserve routes and navigation cache inputs

* fix: repair the static-check failures on the default branch (#2895)

* fix: repair the static-check failures on the default branch

The default branch fails its own required `Static checks` job three ways, so
every pull request reports that job as failed regardless of its own change.

- `npm run format:check` reports `src/domain/functionComparison.test.ts` and
  `src/ida/IdaOperationRunner.ts`.
- `npm run lint` reports a duplicate `import { join } from "node:path"` in
  `tests/boundary/mcp/ghidraInventoryMcp.test.ts` (lines 4 and 17).
- `npm run typecheck` reports `format: "devin"` missing from the client format
  union in `src/application/SupportedClients.ts`, and an unchecked index in
  `tests/boundary/cli/clientProfileLifecycle.test.ts`, whose pair array is
  inferred as `string[][]`.

Apply the pinned formatter, drop the duplicate import, list the `"devin"` format
that its own definition already uses, and mark the pair array `as const`.

Validation: `npm run check:fast` and `npm run format:check` pass.

* fix(setup): keep Devin on the JSON configuration dialect

---------

Co-authored-by: 吴佳浩 <wujiahao@supremind.com>
Co-authored-by: morluto <76467478+morluto@users.noreply.github.com>

* fix(docs): update links after guide relocation

* docs: correct verified documentation route counts

* fix(docs): update browser capture guide link after move (#2820)

Refresh gettext protected-link comments alongside the authored href.

Co-authored-by: Codex <noreply@openai.com>

* fix(docs): include http3 lab in stable routes

* fix(docs): preserve historical release evidence and links

* fix(ghidra): restore Windows verifier identity import

* docs(wakaru): preserve pinned upstream policy link

* docs(index): retain recently added guide links

* docs(mcp): preserve parent retention clarification

* fix(cli): preserve standalone import guidance

* fix(test): preserve translated guide link drift coverage

---------

Co-authored-by: Matheus Breguêz <matbrgz@gmail.com>
Co-authored-by: Codex <noreply@openai.com>
Co-authored-by: morluto <17176810+morluto@users.noreply.github.com>
Co-authored-by: 吴佳浩Alben <35291372+XiaoBinGan@users.noreply.github.com>
Co-authored-by: 吴佳浩 <wujiahao@supremind.com>
2026-11-08 01:42:28 +08:00

2.3 KiB

Implementation plan

Layout and ownership

Keep docs/index.md as the website landing page. Group authored documents under getting-started/, guides/<domain>/, providers/, reference/, development/ and migrations/. Keep the architecture map under architecture/. Add a linked directory describing every category and its files.

Leave assets/, public/, verification/, releases/, error-contract.schema.json and user-visible-errors.csv at their owned paths. The schema generator and catalog/evidence writers retain their current contracts. No root document is converted into a feature specification merely to fit a folder.

Preserve moved basenames. Convert local Markdown links using each document's old and new location, including links to assets and generated references. Update literal physical paths in documentation checks, release tooling and tests. VitePress rewrites map categorized Markdown sources to their original root route, so existing public guide links and anchors remain available. Site navigation continues using public routes; edit links use the actual source path.

Keep the independent native/Pascal work in PR #2400 mergeable by limiting changes to required links in its moved guide. The EVM guide follows the same rule.

Verification

Run documentation-fact checks and the affected README, release and filesystem boundary tests. Build the complete VitePress site with dead-link checks enabled, then compare emitted HTML routes with the pre-migration guide inventory. Inspect the diff for unintended text rewrites and retained generated ownership. Run the repository static checks before requesting review.

Keep a reproducible built-HTML verifier with an independent 58-route baseline, including the new upstream signal guide. Verify physical edit targets, local published files/images and fragment IDs rather than treating a successful build as sufficient link verification. Normalize references to docs/public at the renderer boundary, where VitePress publishes them at the site root. Preserve a legacy managed/native fragment alias while retaining the existing heading. Run this verification in documentation CI and the manual documentation build. Changes to the verifier itself must select the documentation lane; cover this using the actual CI planner against an isolated Git fixture.