mirror of
https://github.com/morluto/rea.git
synced 2026-11-09 00:07:18 +00:00
a67525cdf1
* 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>
1.8 KiB
1.8 KiB
Documentation organization
Problem and outcome
The authored documentation root mixes user workflows, provider setup, contracts, development instructions and release migrations. Several existing guides are missing from site navigation. A contributor needs one documented destination for each kind of document without breaking reader links or automated path consumers.
Tracking issue: https://github.com/morluto/rea/issues/2401.
Requirements
- Categorize every existing authored guide while preserving its basename, substantive content and heading anchors.
- Preserve existing public guide URLs; update physical repository links and tests, release instructions and documentation-fact readers together.
- Expose every existing guide through a documentation directory and categorized site navigation.
- Specify one feature/domain per
docs/specs/<domain>/<feature-slug>/, withspec.md, exactly oneplan.mdandtasks.md. Broad specification roadmaps only list child specifications, order and dependencies. Architectural decisions use individual Michael Nygard ADRs underdocs/adr/<domain>/<decision-slug>.md. - Preserve machine-owned catalog, evidence, schema and release-manifest paths; explain their owners and regeneration commands separately from authored guides.
Acceptance
- Every pre-existing authored Markdown guide has a categorized destination.
- All local Markdown file references resolve after migration.
- A production VitePress build emits all pre-existing guide routes.
- Documentation facts and relevant physical-path consumer tests pass.
- The organization has one implementation plan and incremental task list.
Out of scope
Provider integration, runtime behavior, analysis contracts, new language support, rewriting guide claims, deployment and generated-output ownership changes.