From 13613a0476946df70e02160721919640c70a1cf2 Mon Sep 17 00:00:00 2001 From: morluto <76467478+morluto@users.noreply.github.com> Date: Thu, 19 Nov 2026 20:47:16 -0500 Subject: [PATCH] docs: group guides by task and consolidate verification links --- CONTRIBUTING.md | 22 +- docs/.vitepress/config.ts | 1 - docs/.vitepress/documentation.ts | 614 +++++++++--------- docs/README.md | 162 ++--- docs/agent-environments-quickstart.md | 2 +- docs/agent-environments.md | 2 +- docs/development/documentation.md | 11 +- docs/development/reconstruction-readiness.md | 2 +- docs/development/roadmap.md | 2 +- docs/development/testing.md | 128 +--- docs/guides/javascript/javascript-recovery.md | 2 +- docs/guides/managed/managed-code-analysis.md | 2 +- docs/guides/wasm/wasm-artifacts.md | 2 +- docs/index.md | 35 +- docs/kuna-provider.md | 2 +- 15 files changed, 466 insertions(+), 523 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5019c3d9c8..db75cdbe7e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -327,21 +327,15 @@ for live editing and `npm run docs:preview` to serve an existing build at `/rea/`. Follow the [documentation checks](docs/development/documentation.md#generated-ownership-and-checks) to build and verify the rendered routes and anchors. -Site navigation lives in `docs/.vitepress/config.ts`. Keep links to guides -relative so they work on GitHub and the website; link to repository files -outside `docs/` using their full GitHub URLs. Generated reference documents -use `npm run docs:generate`; `docs:build` generates them before building the website. +The [authoring guide](docs/development/documentation.md#links-and-public-routes) +explains where to edit navigation and how to preserve public links. The +`Documentation` CI job runs the documentation and rendered-route checks. +The manual VitePress workflow in `.github/workflows/pages.yml` builds these +guides for verification. -Pull requests run `npm run docs:check`. `.github/workflows/pages.yml` is a -manual VitePress build and does not publish. The public site at - serves `website/public/` through Cloudflare Workers. See -the [website README](website/README.md#cloudflare-workers) for previews and -manual deployments. - -The separate GitHub Pages host uses only the manual -`.github/workflows/website-pages.yml` workflow on `main`. The repository's -**Settings → Pages → Build and deployment → Source** must be set to -**GitHub Actions** before deploying there. +The product website in `website/public/` has a separate +[publishing workflow](website/README.md#synchronized-production-publishing) for +`rea.tools` and GitHub Pages. ### Translation corrections diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index ed51121c51..e70fc03571 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -93,7 +93,6 @@ export default defineConfig({ text: "Documentation directory", items: [ { text: "All guides", link: "/documentation" }, - { text: "Authoring conventions", link: "/development/documentation" }, { text: "Feature specifications", link: "/specs/" }, { text: "Architecture decisions", link: "/adr/" }, ], diff --git a/docs/.vitepress/documentation.ts b/docs/.vitepress/documentation.ts index 2d2dfd0990..a0e9e34d39 100644 --- a/docs/.vitepress/documentation.ts +++ b/docs/.vitepress/documentation.ts @@ -25,6 +25,61 @@ export const documentationSections = [ }, ], }, + { + text: "Desktop applications", + items: [ + { + text: "Desktop installation directories", + source: "desktop-applications.md", + route: "/desktop-applications", + }, + { + text: "Desktop application capture", + source: "desktop-application-capture.md", + route: "/desktop-application-capture", + }, + { + text: "Desktop application state", + source: "desktop-application-state.md", + route: "/desktop-application-state", + }, + { + text: "Desktop application tasks", + source: "desktop-application-tasks.md", + route: "/desktop-application-tasks", + }, + { + text: "Desktop application export", + source: "desktop-application-export.md", + route: "/desktop-application-export", + }, + { + text: "Desktop build computer", + source: "desktop-build-computer.md", + route: "/desktop-build-computer", + }, + { + text: "Desktop build witness", + source: "desktop-build-witness.md", + route: "/desktop-build-witness", + }, + ], + }, + { + text: "Agent environments", + items: [ + { + text: "Build RL environments with REA", + source: "agent-environments-quickstart.md", + route: "/agent-environments-quickstart", + }, + { + text: "Agent environments from recorded captures", + source: "agent-environments.md", + route: "/agent-environments", + }, + ], + }, { text: "Native binaries", items: [ @@ -38,6 +93,11 @@ export const documentationSections = [ source: "guides/native/go-binaries.md", route: "/go-binaries", }, + { + text: "DWARF compile units", + source: "guides/native/dwarf-units.md", + route: "/dwarf-units", + }, { text: "Offline binary diagnostics", source: "guides/native/binary-diagnostics.md", @@ -74,9 +134,59 @@ export const documentationSections = [ route: "/windows-shortcut", }, { + text: "Acquired NTFS metadata", source: "guides/native/ntfs-metadata.md", route: "/ntfs-metadata", - text: "Acquired NTFS metadata", + }, + { + text: "Binary hardening", + source: "binary-hardening.md", + route: "/binary-hardening", + }, + { + text: "ELF note tables", + source: "elf-notes.md", + route: "/elf-notes", + }, + { + text: "ELF dependency tables", + source: "elf-dependencies.md", + route: "/elf-dependencies", + }, + { + text: "Linux kernel modules", + source: "kernel-modules.md", + route: "/kernel-modules", + }, + { + text: "PE Authenticode certificate tables", + source: "pe-certificates.md", + route: "/pe-certificates", + }, + { + text: "PE import and delay-load tables", + source: "pe-imports.md", + route: "/pe-imports", + }, + { + text: "PE TLS callbacks and load configuration", + source: "pe-load-config.md", + route: "/pe-load-config", + }, + { + text: "Match native functions across builds", + source: "native-function-matching.md", + route: "/native-function-matching", + }, + { + text: "Rust binary dependency metadata", + source: "rust-binaries.md", + route: "/rust-binaries", + }, + { + text: "Static CUDA and HIP code objects", + source: "gpu-code-objects.md", + route: "/gpu-code-objects", }, ], }, @@ -123,6 +233,31 @@ export const documentationSections = [ source: "guides/javascript/v8-code-cache.md", route: "/v8-code-cache", }, + { + text: "Electron fuse state", + source: "electron-fuses.md", + route: "/electron-fuses", + }, + { + text: "Static JavaScript route inventory", + source: "javascript-route-inventory.md", + route: "/javascript-route-inventory", + }, + { + text: "Bun standalone executables", + source: "bun-standalone.md", + route: "/bun-standalone", + }, + { + text: "Deno compile executables", + source: "deno-standalone.md", + route: "/deno-standalone", + }, + { + text: "Node.js single executable applications", + source: "node-sea.md", + route: "/node-sea", + }, ], }, { @@ -168,6 +303,11 @@ export const documentationSections = [ source: "guides/web/website-script-export.md", route: "/website-script-export", }, + { + text: "Offline Playwright traces", + source: "playwright-traces.md", + route: "/playwright-traces", + }, ], }, { @@ -193,6 +333,16 @@ export const documentationSections = [ source: "guides/android/flutter-analysis.md", route: "/flutter-analysis", }, + { + text: "Android boot and vendor_boot images", + source: "android-boot-image.md", + route: "/android-boot-image", + }, + { + text: "APK signature schemes", + source: "apk-signature.md", + route: "/apk-signature", + }, ], }, { @@ -203,6 +353,11 @@ export const documentationSections = [ source: "guides/apple/apple-application-analysis.md", route: "/apple-application-analysis", }, + { + text: "Apple IPS crash reports", + source: "apple-ips.md", + route: "/apple-ips", + }, ], }, { @@ -218,6 +373,16 @@ export const documentationSections = [ source: "guides/managed/nuget-nupkg.md", route: "/nuget-nupkg", }, + { + text: ".NET single-file bundles", + source: "dotnet-bundles.md", + route: "/dotnet-bundles", + }, + { + text: "IL2CPP metadata", + source: "il2cpp-metadata.md", + route: "/il2cpp-metadata", + }, ], }, { @@ -228,6 +393,46 @@ export const documentationSections = [ source: "guides/firmware/firmware-analysis.md", route: "/firmware-analysis", }, + { + text: "Android OTA update payloads", + source: "guides/firmware/android-ota-payload.md", + route: "/android-ota-payload", + }, + { + text: "Flattened devicetree inspection", + source: "devicetree.md", + route: "/devicetree", + }, + { + text: "ESP flash images", + source: "esp-flash-image.md", + route: "/esp-flash-image", + }, + { + text: "ESP images", + source: "esp-image.md", + route: "/esp-image", + }, + { + text: "U-Boot FIT images", + source: "fit-images.md", + route: "/fit-images", + }, + { + text: "Intel HEX and S-record images", + source: "hex-records.md", + route: "/hex-records", + }, + { + text: "UF2 and DfuSe images", + source: "uf2-dfuse.md", + route: "/uf2-dfuse", + }, + { + text: "U-Boot legacy uImage containers", + source: "uimage.md", + route: "/uimage", + }, ], }, { @@ -240,6 +445,71 @@ export const documentationSections = [ }, ], }, + { + text: "Packages and metadata", + items: [ + { + text: "Offline API contract inventory", + source: "api-contracts.md", + route: "/api-contracts", + }, + { + text: "CycloneDX dependencies", + source: "guides/native/cyclonedx-view.md", + route: "/cyclonedx-view", + }, + { + text: "Maven POM and Gradle module metadata", + source: "maven-gradle-metadata.md", + route: "/maven-gradle-metadata", + }, + { + text: "Release exposure", + source: "release-exposure.md", + route: "/release-exposure", + }, + { + text: "Model file declarations", + source: "model-artifacts.md", + route: "/model-artifacts", + }, + { + text: "Python packaged applications", + source: "python-packaged-applications.md", + route: "/python-packaged-applications", + }, + { + text: "CPython pyc inspection", + source: "python-pyc.md", + route: "/python-pyc", + }, + { + text: "Erlang BEAM files", + source: "erlang-beam.md", + route: "/erlang-beam", + }, + { + text: "Godot PCK archives", + source: "godot-pck.md", + route: "/godot-pck", + }, + { + text: "UnityFS AssetBundle archives", + source: "unityfs.md", + route: "/unityfs", + }, + { + text: "iNES containers", + source: "ines-containers.md", + route: "/ines-containers", + }, + { + text: "WeChat mini-program wxapkg archives", + source: "wxapkg.md", + route: "/wxapkg", + }, + ], + }, { text: "WebAssembly", items: [ @@ -348,6 +618,26 @@ export const documentationSections = [ source: "providers/jeb-analysis.md", route: "/jeb-analysis", }, + { + text: "GameCube DOL analysis through Ghidra", + source: "ghidra-dol.md", + route: "/ghidra-dol", + }, + { + text: "PowerPC ELF analysis through Ghidra", + source: "ghidra-ppc.md", + route: "/ghidra-ppc", + }, + { + text: "Kuna provider", + source: "kuna-provider.md", + route: "/kuna-provider", + }, + { + text: "Reverse-engineering tool integrations", + source: "reverse-engineering-tools.md", + route: "/reverse-engineering-tools", + }, ], }, { @@ -363,6 +653,11 @@ export const documentationSections = [ source: "reference/reconstruction-obligation-ledgers.md", route: "/reconstruction-obligation-ledgers", }, + { + text: "Reconstruction coverage", + source: "reconstruction-coverage.md", + route: "/reconstruction-coverage", + }, ], }, { @@ -413,6 +708,26 @@ export const documentationSections = [ source: "development/roadmap.md", route: "/roadmap", }, + { + text: "Capability composition and ownership", + source: "capability-composition.md", + route: "/capability-composition", + }, + { + text: "Testing lanes and provider verification", + source: "testing-lanes.md", + route: "/testing-lanes", + }, + { + text: "Measure MCP catalog costs in Codex", + source: "mcp-catalog-evaluation.md", + route: "/mcp-catalog-evaluation", + }, + { + text: "Static analysis in GitHub Actions", + source: "ci-analysis.md", + route: "/ci-analysis", + }, ], }, { @@ -435,303 +750,6 @@ export const documentationSections = [ }, ], }, - { - text: "Additional guides", - items: [ - { - text: "Offline API contract inventory", - source: "api-contracts.md", - route: "/api-contracts", - }, - { - text: "Bun standalone executables", - source: "bun-standalone.md", - route: "/bun-standalone", - }, - { - text: "Deno compile executables", - source: "deno-standalone.md", - route: "/deno-standalone", - }, - { - text: "Capability composition and ownership", - source: "capability-composition.md", - route: "/capability-composition", - }, - { - text: ".NET single-file bundles", - source: "dotnet-bundles.md", - route: "/dotnet-bundles", - }, - { - text: "ESP flash images", - source: "esp-flash-image.md", - route: "/esp-flash-image", - }, - { - text: "U-Boot FIT images", - source: "fit-images.md", - route: "/fit-images", - }, - { - text: "Measure MCP catalog costs in Codex", - source: "mcp-catalog-evaluation.md", - route: "/mcp-catalog-evaluation", - }, - { - text: "Offline Playwright traces", - source: "playwright-traces.md", - route: "/playwright-traces", - }, - { - text: "Testing lanes and provider verification", - source: "testing-lanes.md", - route: "/testing-lanes", - }, - { - text: "UF2 and DfuSe images", - source: "uf2-dfuse.md", - route: "/uf2-dfuse", - }, - { - text: "WeChat mini-program wxapkg archives", - source: "wxapkg.md", - route: "/wxapkg", - }, - { - text: "Binary hardening", - source: "binary-hardening.md", - route: "/binary-hardening", - }, - { - text: "Desktop application capture", - source: "desktop-application-capture.md", - route: "/desktop-application-capture", - }, - { - text: "Desktop application export", - source: "desktop-application-export.md", - route: "/desktop-application-export", - }, - { - text: "Desktop application state", - source: "desktop-application-state.md", - route: "/desktop-application-state", - }, - { - text: "Desktop application tasks", - source: "desktop-application-tasks.md", - route: "/desktop-application-tasks", - }, - { - text: "Desktop build computer", - source: "desktop-build-computer.md", - route: "/desktop-build-computer", - }, - { - text: "Desktop build witness", - source: "desktop-build-witness.md", - route: "/desktop-build-witness", - }, - { - text: "iNES containers", - source: "ines-containers.md", - route: "/ines-containers", - }, - { - text: "Build RL environments with REA", - source: "agent-environments-quickstart.md", - route: "/agent-environments-quickstart", - }, - { - text: "Agent environments from recorded captures", - source: "agent-environments.md", - route: "/agent-environments", - }, - { - text: "Android boot and vendor_boot images", - source: "android-boot-image.md", - route: "/android-boot-image", - }, - { - text: "APK signature schemes", - source: "apk-signature.md", - route: "/apk-signature", - }, - { - text: "Android OTA update payloads", - source: "guides/firmware/android-ota-payload.md", - route: "/android-ota-payload", - }, - { - text: "Apple IPS crash reports", - source: "apple-ips.md", - route: "/apple-ips", - }, - { - text: "Static analysis in GitHub Actions", - source: "ci-analysis.md", - route: "/ci-analysis", - }, - { - text: "Desktop installation directories", - source: "desktop-applications.md", - route: "/desktop-applications", - }, - { - text: "Flattened devicetree inspection", - source: "devicetree.md", - route: "/devicetree", - }, - { - text: "DWARF compile units", - source: "guides/native/dwarf-units.md", - route: "/dwarf-units", - }, - { - text: "Electron fuse state", - source: "electron-fuses.md", - route: "/electron-fuses", - }, - { text: "ELF note tables", source: "elf-notes.md", route: "/elf-notes" }, - { - text: "ELF dependency tables", - source: "elf-dependencies.md", - route: "/elf-dependencies", - }, - { - text: "Erlang BEAM files", - source: "erlang-beam.md", - route: "/erlang-beam", - }, - { text: "ESP images", source: "esp-image.md", route: "/esp-image" }, - { - text: "GameCube DOL analysis through Ghidra", - source: "ghidra-dol.md", - route: "/ghidra-dol", - }, - { - text: "PowerPC ELF analysis through Ghidra", - source: "ghidra-ppc.md", - route: "/ghidra-ppc", - }, - { - text: "Godot PCK archives", - source: "godot-pck.md", - route: "/godot-pck", - }, - { - text: "Static CUDA and HIP code objects", - source: "gpu-code-objects.md", - route: "/gpu-code-objects", - }, - { - text: "Intel HEX and S-record images", - source: "hex-records.md", - route: "/hex-records", - }, - { - text: "IL2CPP metadata", - source: "il2cpp-metadata.md", - route: "/il2cpp-metadata", - }, - { - text: "Static JavaScript route inventory", - source: "javascript-route-inventory.md", - route: "/javascript-route-inventory", - }, - { - text: "Linux kernel modules", - source: "kernel-modules.md", - route: "/kernel-modules", - }, - { - text: "Kuna provider", - source: "kuna-provider.md", - route: "/kuna-provider", - }, - { - text: "Maven POM and Gradle module metadata", - source: "maven-gradle-metadata.md", - route: "/maven-gradle-metadata", - }, - { - text: "Model file declarations", - source: "model-artifacts.md", - route: "/model-artifacts", - }, - { - text: "Match native functions across builds", - source: "native-function-matching.md", - route: "/native-function-matching", - }, - { - text: "Node.js single executable applications", - source: "node-sea.md", - route: "/node-sea", - }, - { - text: "PE Authenticode certificate tables", - source: "pe-certificates.md", - route: "/pe-certificates", - }, - { - text: "PE import and delay-load tables", - source: "pe-imports.md", - route: "/pe-imports", - }, - { - text: "PE TLS callbacks and load configuration", - source: "pe-load-config.md", - route: "/pe-load-config", - }, - { - text: "Python packaged applications", - source: "python-packaged-applications.md", - route: "/python-packaged-applications", - }, - { - text: "CPython pyc inspection", - source: "python-pyc.md", - route: "/python-pyc", - }, - { - text: "Reconstruction coverage", - source: "reconstruction-coverage.md", - route: "/reconstruction-coverage", - }, - { - text: "Release exposure", - source: "release-exposure.md", - route: "/release-exposure", - }, - { - text: "Reverse-engineering tool integrations", - source: "reverse-engineering-tools.md", - route: "/reverse-engineering-tools", - }, - { - text: "Rust binary dependency metadata", - source: "rust-binaries.md", - route: "/rust-binaries", - }, - { - text: "CycloneDX dependencies", - source: "guides/native/cyclonedx-view.md", - route: "/cyclonedx-view", - }, - { - text: "U-Boot legacy uImage containers", - source: "uimage.md", - route: "/uimage", - }, - { - text: "UnityFS AssetBundle archives", - source: "unityfs.md", - route: "/unityfs", - }, - ], - }, ]; export const documentationRewrites = Object.fromEntries( diff --git a/docs/README.md b/docs/README.md index 27e490bb41..85ee66b5d9 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,8 +1,7 @@ # Documentation directory -REA documentation is organized by reader task and document owner. This directory -links every authored guide; the [site](https://rea.tools/) also serves separate -product pages. The VitePress documentation source is this `docs/` tree. +Find an installation step, investigation guide, or contributor reference by task. +The [REA website](https://rea.tools/) has worked examples and product pages. ## Getting started @@ -11,6 +10,21 @@ product pages. The VitePress documentation source is this `docs/` tree. - [CLI and Evidence](getting-started/cli.md) - [Guided MCP prompts and completion](getting-started/mcp-prompts.md) +## Desktop applications + +- [Desktop installation directories](desktop-applications.md) +- [Desktop application capture](desktop-application-capture.md) +- [Desktop application state](desktop-application-state.md) +- [Desktop application tasks](desktop-application-tasks.md) +- [Desktop application export](desktop-application-export.md) +- [Desktop build computer](desktop-build-computer.md) +- [Desktop build witness](desktop-build-witness.md) + +## Agent environments + +- [Build RL environments with REA](agent-environments-quickstart.md) +- [Agent environments from recorded captures](agent-environments.md) + ## Native binaries - [Native binary investigation](guides/native/native-investigation.md) @@ -22,9 +36,18 @@ product pages. The VitePress documentation source is this `docs/` tree. - [ELF unwind function ranges](guides/native/elf-unwind-ranges.md) - [Linux kernel build config](guides/native/kernel-build-config.md) - [Recorded crash evidence](guides/native/recorded-crashes.md) -- [CycloneDX dependencies](guides/native/cyclonedx-view.md) - [Windows Shell Link shortcuts](guides/native/windows-shortcut.md) -- [Acquired NTFS metadata and change journals](guides/native/ntfs-metadata.md) +- [Acquired NTFS metadata](guides/native/ntfs-metadata.md) +- [Binary hardening](binary-hardening.md) +- [ELF note tables](elf-notes.md) +- [ELF dependency tables](elf-dependencies.md) +- [Linux kernel modules](kernel-modules.md) +- [PE Authenticode certificate tables](pe-certificates.md) +- [PE import and delay-load tables](pe-imports.md) +- [PE TLS callbacks and load configuration](pe-load-config.md) +- [Match native functions across builds](native-function-matching.md) +- [Rust binary dependency metadata](rust-binaries.md) +- [Static CUDA and HIP code objects](gpu-code-objects.md) ## JavaScript and Electron @@ -36,6 +59,11 @@ product pages. The VitePress documentation source is this `docs/` tree. - [JavaScript static/runtime reconciliation](guides/javascript/javascript-runtime-reconciliation.md) - [Electron file-page observation](guides/javascript/electron-observation.md) - [V8 code cache inspection](guides/javascript/v8-code-cache.md) +- [Electron fuse state](electron-fuses.md) +- [Static JavaScript route inventory](javascript-route-inventory.md) +- [Bun standalone executables](bun-standalone.md) +- [Deno compile executables](deno-standalone.md) +- [Node.js single executable applications](node-sea.md) ## Browser and captured websites @@ -47,6 +75,7 @@ product pages. The VitePress documentation source is this `docs/` tree. - [Captured website source locations](guides/web/web-source-location.md) - [Captured website module relationships](guides/web/website-module-trace.md) - [Captured website scripts and static JavaScript analysis](guides/web/website-script-export.md) +- [Offline Playwright traces](playwright-traces.md) ## Android applications @@ -54,23 +83,54 @@ product pages. The VitePress documentation source is this `docs/` tree. - [Apktool resource decoding](guides/android/apktool-resource-analysis.md) - [ADB device inspection and acquisition](guides/android/adb-device-analysis.md) - [Flutter build identification](guides/android/flutter-analysis.md) +- [Android boot and vendor_boot images](android-boot-image.md) +- [APK signature schemes](apk-signature.md) ## Apple applications - [Apple Application Inventory Projection](guides/apple/apple-application-analysis.md) +- [Apple IPS crash reports](apple-ips.md) ## .NET assemblies - [Managed-code analysis](guides/managed/managed-code-analysis.md) +- [NuGet packages](guides/managed/nuget-nupkg.md) +- [.NET single-file bundles](dotnet-bundles.md) +- [IL2CPP metadata](il2cpp-metadata.md) ## Firmware - [Firmware analysis](guides/firmware/firmware-analysis.md) +- [Android OTA update payloads](guides/firmware/android-ota-payload.md) +- [Flattened devicetree inspection](devicetree.md) +- [ESP flash images](esp-flash-image.md) +- [ESP images](esp-image.md) +- [U-Boot FIT images](fit-images.md) +- [Intel HEX and S-record images](hex-records.md) +- [UF2 and DfuSe images](uf2-dfuse.md) +- [U-Boot legacy uImage containers](uimage.md) ## HarmonyOS packages - [Static HarmonyOS package inventory](guides/harmony/harmony-analysis.md) + + +## Packages and metadata + +- [Offline API contract inventory](api-contracts.md) +- [CycloneDX dependencies](guides/native/cyclonedx-view.md) +- [Maven POM and Gradle module metadata](maven-gradle-metadata.md) +- [Release exposure](release-exposure.md) +- [Model file declarations](model-artifacts.md) +- [Python packaged applications](python-packaged-applications.md) +- [CPython pyc inspection](python-pyc.md) +- [Erlang BEAM files](erlang-beam.md) +- [Godot PCK archives](godot-pck.md) +- [UnityFS AssetBundle archives](unityfs.md) +- [iNES containers](ines-containers.md) +- [WeChat mini-program wxapkg archives](wxapkg.md) + ## WebAssembly - [Offline WebAssembly artifacts](guides/wasm/wasm-artifacts.md) @@ -90,10 +150,6 @@ product pages. The VitePress documentation source is this `docs/` tree. - [Process capture](guides/runtime/process-capture.md) - [Frida instrumentation](guides/runtime/frida-instrumentation.md) -## Signal recordings - -- [Recorded signal inspection](guides/signals/signal-recordings.md) - ## Provider setup and formats - [Ghidra provider semantics](providers/ghidra-provider.md) @@ -106,14 +162,20 @@ product pages. The VitePress documentation source is this `docs/` tree. - [Headerless raw-binary analysis with Ghidra](providers/raw-binary.md) - [IDA provider](providers/ida-provider.md) - [JEB instrumentation and analysis](providers/jeb-analysis.md) +- [GameCube DOL analysis through Ghidra](ghidra-dol.md) +- [PowerPC ELF analysis through Ghidra](ghidra-ppc.md) +- [Kuna provider](kuna-provider.md) +- [Reverse-engineering tool integrations](reverse-engineering-tools.md) ## Contracts and evidence - [MCP runtime contracts](reference/mcp-contracts.md) - [Reconstruction obligation ledgers](reference/reconstruction-obligation-ledgers.md) +- [Reconstruction coverage](reconstruction-coverage.md) ## Development and verification +- [Documentation ownership and authoring](development/documentation.md) - [Settings and recovery](design/limits-and-recovery.md) - [REA limit inventory](design/rea-limit-inventory.md) - [MCP tool design](development/tool-design.md) @@ -122,19 +184,28 @@ product pages. The VitePress documentation source is this `docs/` tree. - [Reconstruction readiness conformance](development/reconstruction-readiness.md) - [Releasing REA](development/releasing.md) - [REA roadmap](development/roadmap.md) +- [Capability composition and ownership](capability-composition.md) +- [Testing lanes and provider verification](testing-lanes.md) +- [Measure MCP catalog costs in Codex](mcp-catalog-evaluation.md) +- [Static analysis in GitHub Actions](ci-analysis.md) ## Release migrations - [Upgrading from REA 6.1 to 6.2](migrations/migration-6.2.md) +## Signal recordings + +- [Recorded signal inspection](guides/signals/signal-recordings.md) + ## Architecture and authoring - [Architecture map](https://github.com/morluto/rea/blob/main/docs/architecture/architecture.mermaid) -- [Documentation ownership and contribution model](development/documentation.md) - [Feature specifications](specs/README.md) - [Architectural decision records](adr/README.md) -## Machine-owned documentation + + +## Generated files and release records | Path | Owner and update command | | ----------------------------------------- | ------------------------------------------------------------------------------------------------------- | @@ -143,70 +214,7 @@ product pages. The VitePress documentation source is this `docs/` tree. | `error-contract.schema.json` | Tracked schema from contracts; `npm run docs:error-schema` | | `user-visible-errors.csv` | Generated error code and category per domain and provider-owned error case; `npm run docs:error-schema` | | `releases/.contributions.json` | Durable release contribution record; follow the [release guide](development/releasing.md) | -| `assets/` | Shared authored images referenced by guides | -Do not edit generated catalogs or evidence to change product facts. Change their -canonical contracts or producer and regenerate. Historical release records retain -the exact commit messages and references from the release they describe. - -## Additional guides - -- [Offline API contract inventory](api-contracts.md) -- [Bun standalone executables](bun-standalone.md) -- [Deno compile executables](deno-standalone.md) -- [Capability composition and ownership](capability-composition.md) -- [.NET single-file bundles](dotnet-bundles.md) -- [ESP flash images](esp-flash-image.md) -- [U-Boot FIT images](fit-images.md) -- [Measure MCP catalog costs in Codex](mcp-catalog-evaluation.md) -- [Offline Playwright traces](playwright-traces.md) -- [Testing lanes and provider verification](testing-lanes.md) -- [UF2 and DfuSe images](uf2-dfuse.md) -- [WeChat mini-program wxapkg archives](wxapkg.md) -- [Binary hardening](binary-hardening.md) -- [Desktop application capture](desktop-application-capture.md) -- [Desktop application export](desktop-application-export.md) -- [Desktop application state](desktop-application-state.md) -- [Desktop application tasks](desktop-application-tasks.md) -- [Desktop build computer](desktop-build-computer.md) -- [Desktop build witness](desktop-build-witness.md) -- [iNES containers](ines-containers.md) -- [Build RL environments with REA](agent-environments-quickstart.md) -- [Agent environments from recorded captures](agent-environments.md) -- [Android boot and vendor_boot images](android-boot-image.md) -- [APK signature schemes](apk-signature.md) -- [Android OTA update payloads](guides/firmware/android-ota-payload.md) -- [Apple IPS crash reports](apple-ips.md) -- [Static analysis in GitHub Actions](ci-analysis.md) -- [Desktop installation directories](desktop-applications.md) -- [Flattened devicetree inspection](devicetree.md) -- [Electron fuse state](electron-fuses.md) -- [ELF note tables](elf-notes.md) -- [ELF dependency tables](elf-dependencies.md) -- [Erlang BEAM files](erlang-beam.md) -- [ESP images](esp-image.md) -- [GameCube DOL analysis through Ghidra](ghidra-dol.md) -- [PowerPC ELF analysis through Ghidra](ghidra-ppc.md) -- [Godot PCK archives](godot-pck.md) -- [Static CUDA and HIP code objects](gpu-code-objects.md) -- [Intel HEX and S-record images](hex-records.md) -- [IL2CPP metadata](il2cpp-metadata.md) -- [Static JavaScript route inventory](javascript-route-inventory.md) -- [Linux kernel modules](kernel-modules.md) -- [Kuna provider](kuna-provider.md) -- [Maven POM and Gradle module metadata](maven-gradle-metadata.md) -- [Model file declarations](model-artifacts.md) -- [Match native functions across builds](native-function-matching.md) -- [Node.js single executable applications](node-sea.md) -- [NuGet packages](guides/managed/nuget-nupkg.md) -- [PE Authenticode certificate tables](pe-certificates.md) -- [PE import and delay-load tables](pe-imports.md) -- [PE TLS callbacks and load configuration](pe-load-config.md) -- [Python packaged applications](python-packaged-applications.md) -- [CPython pyc inspection](python-pyc.md) -- [Reconstruction coverage](reconstruction-coverage.md) -- [Release exposure](release-exposure.md) -- [Reverse-engineering tool integrations](reverse-engineering-tools.md) -- [Rust binary dependency metadata](rust-binaries.md) -- [U-Boot legacy uImage containers](uimage.md) -- [UnityFS AssetBundle archives](unityfs.md) +Regenerate catalogs and Evidence projections from their canonical source. +Release records preserve the exact commit messages and references for each release. +Guides share authored images in `assets/`. diff --git a/docs/agent-environments-quickstart.md b/docs/agent-environments-quickstart.md index aca00484c3..666133f74a 100644 --- a/docs/agent-environments-quickstart.md +++ b/docs/agent-environments-quickstart.md @@ -18,7 +18,7 @@ records the app you provide; you start it and prepare its test data. To run the exported environment, install the [AgentEnv framework](https://github.com/scaleapi/agentenv-framework#install) -and start Docker. REA's [compatibility check](development/testing.md#exported-environment-bundles) +and start Docker. REA's [compatibility check](testing-lanes.md#exported-environment-bundles) uses AgentEnv version `0.9.1431` with Python 3.12. There are two ways to build an environment: ask your agent to record the app, diff --git a/docs/agent-environments.md b/docs/agent-environments.md index a304d72eab..af128be676 100644 --- a/docs/agent-environments.md +++ b/docs/agent-environments.md @@ -1200,7 +1200,7 @@ read, not that the write had no other effect. ## Compatibility verification `npm run verify:agentenv:environment` is the hosted `real-agentenv` lane -described in [testing](development/testing.md#exported-environment-bundles). It projects +described in [exported bundle verification](testing-lanes.md#exported-environment-bundles). It projects the Grafana-shaped source-owned capture through the built CLI, packs the checkout, exports a bundle with `--package-tarball`, runs it with the pinned `agentenv-framework` release on the runner's Docker and requires the smoke task diff --git a/docs/development/documentation.md b/docs/development/documentation.md index b7dc3efa47..ad4dba7884 100644 --- a/docs/development/documentation.md +++ b/docs/development/documentation.md @@ -70,7 +70,8 @@ existing heading anchors when moving a guide. [`documentation.ts`](https://github.com/morluto/rea/blob/main/docs/.vitepress/documentation.ts) owns categorized site navigation and the existing guides' stable public routes. -Update it when adding or moving a guide. VitePress rewrites categorized sources +Update it and the [documentation directory](../README.md) when adding or +recategorizing a guide. VitePress rewrites categorized sources to the existing public paths; its Markdown hook resolves repository links from the physical source and renders them against those public routes. Keep basenames and route assignments unique. Edit links use the physical source file. @@ -82,10 +83,10 @@ historical release records and references bound to earlier commits or tags. ## Generated ownership and checks -The [documentation directory](../README.md#machine-owned-documentation) identifies -the machine-owned outputs and their producers. Their existing paths are retained -because scripts, package consumers and release history depend on them. Change -canonical sources and regenerate; do not fix a generated projection by hand. +The [documentation directory](../README.md#generated-files-and-release-records) lists +generated files, their producers, and release records. Scripts, package +consumers, and release history depend on the listed paths. Update the producer +or its inputs and regenerate. Do not write the number of tools in living prose; link the generated catalog instead. `docs:check` refuses a count of ten or more tools outside dated diff --git a/docs/development/reconstruction-readiness.md b/docs/development/reconstruction-readiness.md index 5c80371904..70842ae71a 100644 --- a/docs/development/reconstruction-readiness.md +++ b/docs/development/reconstruction-readiness.md @@ -145,5 +145,5 @@ npm run test:local -- tests/conformance/readiness/report/reconstructionReadiness ``` Passing evaluator tests does not establish real-provider or fixture runtime -behavior. Use the applicable [real-toolchain lanes](testing.md#real-toolchain-verification-lanes) +behavior. Use the applicable [real-toolchain lanes](../testing-lanes.md#real-toolchain-verification-lanes) for those claims. diff --git a/docs/development/roadmap.md b/docs/development/roadmap.md index 150415b8b1..338c99e1ff 100644 --- a/docs/development/roadmap.md +++ b/docs/development/roadmap.md @@ -25,7 +25,7 @@ constraints. Agents compose experiments using ordinary commands, scripts, and fixture servers; custom orchestration needs a demonstrated requirement. Provider and platform claims require their corresponding -[real verification lanes](testing.md#real-toolchain-verification-lanes). +[real verification lanes](../testing-lanes.md#real-toolchain-verification-lanes). See [tool design](tool-design.md) for choosing a tool boundary and [Ghidra semantics](../providers/ghidra-provider.md) for the existing deep-provider contract. diff --git a/docs/development/testing.md b/docs/development/testing.md index 050c52b662..11bf2db772 100644 --- a/docs/development/testing.md +++ b/docs/development/testing.md @@ -1476,104 +1476,34 @@ The required checks still report on every PR and fail closed: ## Real-toolchain verification lanes -See [Real-toolchain verification lanes](../testing-lanes.md#real-toolchain-verification-lanes). +Use [Testing lanes and provider verification](../testing-lanes.md) to choose a +command for the host, provider, and workflow you changed. Record which lane +ran and which coverage was unavailable. -## Android APK analysis + -See [Android APK analysis](../testing-lanes.md#android-apk-analysis). - -## Apktool resource decoding - -See [Apktool resource decoding](../testing-lanes.md#apktool-resource-decoding). - -## Flutter build identification - -See [Flutter build identification](../testing-lanes.md#flutter-build-identification). - -## ADB device acquisition - -See [ADB device acquisition](../testing-lanes.md#adb-device-acquisition). - -## Optional NativeAOT Ghidra analysis - -See [Optional NativeAOT Ghidra analysis](../testing-lanes.md#optional-nativeaot-ghidra-analysis). - -## IDA MCP adapter - -See [IDA MCP adapter](../testing-lanes.md#ida-mcp-adapter). - -## Kuna lane - -See [Kuna lane](../testing-lanes.md#kuna-lane). - -## DOS Ghidra analysis - -See [DOS Ghidra analysis](../testing-lanes.md#dos-ghidra-analysis). - -## Apple Interface Builder archives - -See [Apple Interface Builder archives](../testing-lanes.md#apple-interface-builder-archives). - -## Native platform baseline in CI - -See [Native platform baseline in CI](../testing-lanes.md#native-platform-baseline-in-ci). - -### Termux Android browser smoke test - -See [Termux Android browser smoke test](../testing-lanes.md#termux-android-browser-smoke-test). - -## Packet capture analysis - -See [Packet capture analysis](../testing-lanes.md#packet-capture-analysis). - -## Apple native metadata and UI - -See [Apple native metadata and UI](../testing-lanes.md#apple-native-metadata-and-ui). - -### Firmware adapters - -See [Firmware adapters](../testing-lanes.md#firmware-adapters). - -### JavaScript source recovery - -See [JavaScript source recovery](../testing-lanes.md#javascript-source-recovery). - -### Captured website source-map lane - -See [Captured website source-map lane](../testing-lanes.md#captured-website-source-map-lane). - -### JavaScript large-output lane - -See [JavaScript large-output lane](../testing-lanes.md#javascript-large-output-lane). - -### Website runtime attribution lane - -See [Website runtime attribution lane](../testing-lanes.md#website-runtime-attribution-lane). - -### Offline binary layout - -See [Offline binary layout](../testing-lanes.md#offline-binary-layout). - -### Offline EVM interface - -See [Offline EVM interface](../testing-lanes.md#offline-evm-interface). - -### Recorded crash evidence - -See [Recorded crash evidence](../testing-lanes.md#recorded-crash-evidence). - -### Exported environment bundles - -See [Exported environment bundles](../testing-lanes.md#exported-environment-bundles). - -## Agent evaluation and conformance records - -See [Agent evaluation and conformance records](../testing-lanes.md#agent-evaluation-and-conformance-records). - -## Frida instrumentation - -See [Frida instrumentation](../testing-lanes.md#frida-instrumentation). - -### Offline WASM artifacts - -See [Offline WASM artifacts](../testing-lanes.md#offline-wasm-artifacts). +- [Android APK analysis](../testing-lanes.md#android-apk-analysis) +- [Apktool resource decoding](../testing-lanes.md#apktool-resource-decoding) +- [Flutter build identification](../testing-lanes.md#flutter-build-identification) +- [ADB device acquisition](../testing-lanes.md#adb-device-acquisition) +- [Optional NativeAOT Ghidra analysis](../testing-lanes.md#optional-nativeaot-ghidra-analysis) +- [IDA MCP adapter](../testing-lanes.md#ida-mcp-adapter) +- [Kuna lane](../testing-lanes.md#kuna-lane) +- [DOS Ghidra analysis](../testing-lanes.md#dos-ghidra-analysis) +- [Apple Interface Builder archives](../testing-lanes.md#apple-interface-builder-archives) +- [Native platform baseline in CI](../testing-lanes.md#native-platform-baseline-in-ci) +- [Termux Android browser smoke test](../testing-lanes.md#termux-android-browser-smoke-test) +- [Packet capture analysis](../testing-lanes.md#packet-capture-analysis) +- [Apple native metadata and UI](../testing-lanes.md#apple-native-metadata-and-ui) +- [Firmware adapters](../testing-lanes.md#firmware-adapters) +- [JavaScript source recovery](../testing-lanes.md#javascript-source-recovery) +- [Captured website source-map lane](../testing-lanes.md#captured-website-source-map-lane) +- [JavaScript large-output lane](../testing-lanes.md#javascript-large-output-lane) +- [Website runtime attribution lane](../testing-lanes.md#website-runtime-attribution-lane) +- [Offline binary layout](../testing-lanes.md#offline-binary-layout) +- [Offline EVM interface](../testing-lanes.md#offline-evm-interface) +- [Recorded crash evidence](../testing-lanes.md#recorded-crash-evidence) +- [Exported environment bundles](../testing-lanes.md#exported-environment-bundles) +- [Agent evaluation and conformance records](../testing-lanes.md#agent-evaluation-and-conformance-records) +- [Frida instrumentation](../testing-lanes.md#frida-instrumentation) +- [Offline WASM artifacts](../testing-lanes.md#offline-wasm-artifacts) diff --git a/docs/guides/javascript/javascript-recovery.md b/docs/guides/javascript/javascript-recovery.md index 399fcd2bbb..75c91ce148 100644 --- a/docs/guides/javascript/javascript-recovery.md +++ b/docs/guides/javascript/javascript-recovery.md @@ -149,6 +149,6 @@ non-retryable `resource_constraint` with `resource: "file-size"` and valid UTF-8 is an `invalid_format` request issue. These limits apply per operation and do not claim aggregate host containment across concurrent callers. -See [testing.md](../../development/testing.md#javascript-source-recovery) for the focused real +See [source recovery verification](../../testing-lanes.md#javascript-source-recovery) for the focused real Wakaru CLI/MCP lane and its source-owned compiler fixtures. Other host platforms and Bun/Vue recovery are not claimed by this adapter. diff --git a/docs/guides/managed/managed-code-analysis.md b/docs/guides/managed/managed-code-analysis.md index 6e2749d35f..fa4117c5b6 100644 --- a/docs/guides/managed/managed-code-analysis.md +++ b/docs/guides/managed/managed-code-analysis.md @@ -944,7 +944,7 @@ The current lane uses source-owned byte-built fixtures and malformed-input regressions, with optional operator-supplied applications and ILSpy verification. Run the deterministic lane with `npm run verify:managed`. See -[testing](../../development/testing.md#real-toolchain-verification-lanes) for prerequisites and +[testing](../../testing-lanes.md#real-toolchain-verification-lanes) for prerequisites and coverage. Generated outputs belong outside tracked fixture directories and must not remain after verification or packaging. diff --git a/docs/guides/wasm/wasm-artifacts.md b/docs/guides/wasm/wasm-artifacts.md index 4b7430ab7b..d685485ee0 100644 --- a/docs/guides/wasm/wasm-artifacts.md +++ b/docs/guides/wasm/wasm-artifacts.md @@ -196,7 +196,7 @@ Candidates are caller-selected files; their identity does not imply validation. Both CLI and MCP use the same typed port and application service. MCP publishes SDK-compatible schemas and records Evidence for `get_evidence_bundle` readback. See [WABT provenance](https://github.com/morluto/rea/blob/main/third_party/wabt/README.md) and -[testing](../../development/testing.md#offline-wasm-artifacts) for real-tool verification. +[testing lanes](../../testing-lanes.md#offline-wasm-artifacts) for real-tool verification. ## Compare core-module interfaces diff --git a/docs/index.md b/docs/index.md index ff7104ffe0..3906d8b844 100644 --- a/docs/index.md +++ b/docs/index.md @@ -47,27 +47,20 @@ For runtime instrumentation, see the [Frida guide](guides/runtime/frida-instrume ## Choose a guide -The [documentation directory](README.md) lists every guide by domain. +- [Inspect an installation directory](desktop-applications.md) to identify its + runtime and choose the next files to examine. +- [Investigate a native binary](guides/native/native-investigation.md) or + [choose a provider](README.md#provider-setup-and-formats) for your host and target. +- [Analyze JavaScript or Electron artifacts](guides/javascript/javascript-artifact-reconstruction.md) + or [relate static findings to runtime observations](guides/javascript/javascript-runtime-reconciliation.md). +- [Observe a website with CDP](guides/web/browser-observation.md) or + [inspect an existing network capture](guides/web/web-network-captures.md). +- [Build an agent environment from a recording](agent-environments-quickstart.md) + or [capture a Linux desktop application](desktop-application-capture.md). +- [Use the CLI and retain Evidence](getting-started/cli.md) or + [look up MCP result and session contracts](reference/mcp-contracts.md). -| Task | Guides | -| --------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Identify a desktop installation | [Runtime candidates, evidence and follow-up files](desktop-applications.md) | -| Inspect native functions, references, or types | [Native binaries](guides/native/native-investigation.md), [Go metadata](guides/native/go-binaries.md), [Rust dependencies](rust-binaries.md), [CPython pyc files](python-pyc.md), [PE certificates](pe-certificates.md), [PE imports](pe-imports.md), [PE TLS/load config](pe-load-config.md), [ELF notes](elf-notes.md), [DWARF compile units](guides/native/dwarf-units.md), [ELF debug files](guides/native/elf-debug-link.md), [ELF dependencies](elf-dependencies.md), [initializer functions](guides/native/native-initializers.md), [ELF unwind ranges](guides/native/elf-unwind-ranges.md), [Linux kernel modules](kernel-modules.md), [Linux kernel build config](guides/native/kernel-build-config.md), [Apple IPS](apple-ips.md), [Erlang BEAM](erlang-beam.md), [offline ELF layout](guides/native/binary-diagnostics.md), [recorded crashes](guides/native/recorded-crashes.md) | -| Select a native provider or import format | [Ghidra semantics](providers/ghidra-provider.md), [Windows](providers/windows-ghidra-p0.md), [DOS](providers/ghidra-dos.md), [raw bytes](providers/raw-binary.md), [GameCube DOL](ghidra-dol.md), [MIPS](providers/ghidra-mips.md), [RISC-V](providers/ghidra-riscv.md), [PowerPC](ghidra-ppc.md), [PSP](providers/ghidra-psp.md), [NativeAOT](providers/ghidra-nativeaot.md), [IDA](providers/ida-provider.md), [Kuna](kuna-provider.md), [JEB](providers/jeb-analysis.md) | -| Analyze JavaScript or Electron artifacts | [Static analysis](guides/javascript/javascript-artifact-reconstruction.md), [tracing and comparisons](guides/javascript/javascript-application-workflows.md), [application graph](guides/javascript/javascript-application-graph.md), [source recovery](guides/javascript/javascript-recovery.md) | -| Compare static JavaScript with runtime observations | [Runtime attribution](guides/javascript/javascript-runtime-observation.md), [reconciliation](guides/javascript/javascript-runtime-reconciliation.md), [Electron observation](guides/javascript/electron-observation.md), [Electron fuses](electron-fuses.md), [Release exposure](release-exposure.md) | -| Inspect assemblies, packages, or firmware | [Godot PCK](godot-pck.md), [UnityFS](unityfs.md), [wxapkg](wxapkg.md), [U-Boot uImage](uimage.md), [Android boot images](android-boot-image.md), [.NET](guides/managed/managed-code-analysis.md), [NuGet packages](guides/managed/nuget-nupkg.md), [Maven POM and Gradle module metadata](maven-gradle-metadata.md), [Python packages](python-packaged-applications.md), [Android](guides/android/android-analysis.md), [Android OTA payloads](guides/firmware/android-ota-payload.md), [APK signatures](apk-signature.md), [Apktool resources](guides/android/apktool-resource-analysis.md), [ADB acquisition](guides/android/adb-device-analysis.md), [Apple](guides/apple/apple-application-analysis.md), [Harmony](guides/harmony/harmony-analysis.md), [firmware](guides/firmware/firmware-analysis.md), [Device Tree](devicetree.md), [FIT images](fit-images.md), [UF2/DfuSe](uf2-dfuse.md), [Flutter](guides/android/flutter-analysis.md), [ESP images](esp-image.md), [ESP flash images](esp-flash-image.md), [WASM](guides/wasm/wasm-artifacts.md), [EVM](guides/evm/evm-bytecode.md) | -| Observe or compare a browser scenario | [CDP observation](guides/web/browser-observation.md), [scenarios](guides/web/browser-scenario-contract.md), [runtime evidence](guides/web/web-runtime.md), [historical captures](guides/web/web-network-captures.md) | -| Serve recorded behavior as an agent environment | [Agent environments](agent-environments.md) | -| Trace captured website source | [Source locations](guides/web/web-source-location.md), [module traces](guides/web/website-module-trace.md), [script export](guides/web/website-script-export.md) | -| Capture and compare a command | [Process capture](guides/runtime/process-capture.md) | -| Use CLI/MCP and retain evidence | [CLI](getting-started/cli.md), [MCP contracts](reference/mcp-contracts.md), [agent prompts](getting-started/mcp-prompts.md), [obligation ledgers](reference/reconstruction-obligation-ledgers.md) | - -For development, use [testing](development/testing.md), [client verification](development/client-verification.md), -[tool design](development/tool-design.md), [admission limits and recovery](design/limits-and-recovery.md), -and [releasing](development/releasing.md). -[Reconstruction readiness](development/reconstruction-readiness.md) describes a development -conformance verifier. [The 6.2 migration](migrations/migration-6.2.md) records that release's -compatibility changes; [the roadmap](development/roadmap.md) tracks future work. +Browse the [documentation directory](README.md) for formats, provider +prerequisites, and contributor references. ![REA inspecting a native binary in Hopper](./assets/rea-hopper-analysis.png) diff --git a/docs/kuna-provider.md b/docs/kuna-provider.md index f3030d2142..2e42ff46ab 100644 --- a/docs/kuna-provider.md +++ b/docs/kuna-provider.md @@ -232,7 +232,7 @@ REA_KUNA_COMMAND=/absolute/path/to/kuna GHIDRA_INSTALL_DIR=/absolute/path/to/ghi npm run verify:kuna -- --targets DIR --functions inflate,crc32 --compare-ghidra ``` -The lane compiles a small source-owned fixture with the host C compiler and verifies the MCP workflow end to end. `--targets DIR --functions a,b` adds caller-built binaries. `--compare-ghidra` (with `GHIDRA_INSTALL_DIR`) runs those same functions through Ghidra; it requires `--targets` and `--functions` and refuses empty matrices or requested function names missing from every target. The report lists examined caller binaries and their matching requested symbols, including inputs omitted from analysis. See [testing](development/testing.md#kuna-lane) for coverage. +The lane compiles a small source-owned fixture with the host C compiler and verifies the MCP workflow end to end. `--targets DIR --functions a,b` adds caller-built binaries. `--compare-ghidra` (with `GHIDRA_INSTALL_DIR`) runs those same functions through Ghidra; it requires `--targets` and `--functions` and refuses empty matrices or requested function names missing from every target. The report lists examined caller binaries and their matching requested symbols, including inputs omitted from analysis. See [testing](testing-lanes.md#kuna-lane) for coverage. Failed runs also report process-lineage evidence and exit unsuccessfully. If provider or transport cleanup is unconfirmed, the report says `cleanup: "incomplete"` and records `retained_workspace`; that directory is preserved for investigation and cleanup retries.