[PR #3855] [MERGED] docs(kuna): document the Kuna provider and list it in the catalog #5952

Closed
opened 2026-10-31 01:10:41 +00:00 by bsakaguchi · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/3855
Author: @kaoru0822-kitauji
Created: 10/15/2026
Status: ✅ Merged
Merged: 10/15/2026
Merged by: @kaoru0822-kitauji

Base: feat/kuna-provider ← Head: feat/kuna-docs


📝 Commits (4)

  • 5841ba6 docs(kuna): document the Kuna provider and list it in the catalog
  • fa52fba docs(kuna): state the Linux cache fallback, raw_result scope and comparison inputs
  • 1d4dba7 docs(kuna): note that cache pins hold within one REA process
  • 52921e4 docs(kuna): describe retired staging and retried cleanup

📊 Changes

30 files changed (+156 additions, -32 deletions)

View changed files

📝 .agents/skills/reverse-engineer-anything/SKILL.md (+11 -2)
📝 README.md (+2 -1)
📝 THIRD_PARTY_NOTICES.md (+1 -0)
📝 docs/.vitepress/config.ts (+1 -0)
📝 docs/cli.md (+3 -2)
📝 docs/index.md (+1 -1)
📝 docs/installation.md (+7 -7)
➕ docs/kuna-provider.md (+80 -0)
📝 docs/readme/README_ar.md (+1 -1)
📝 docs/readme/README_de.md (+1 -1)
📝 docs/readme/README_el.md (+1 -1)
📝 docs/readme/README_es.md (+1 -1)
📝 docs/readme/README_fa.md (+1 -1)
📝 docs/readme/README_fr.md (+1 -1)
📝 docs/readme/README_id.md (+1 -1)
📝 docs/readme/README_it.md (+1 -1)
📝 docs/readme/README_ja.md (+1 -1)
📝 docs/readme/README_ko.md (+1 -1)
📝 docs/readme/README_pl.md (+1 -1)
📝 docs/readme/README_pt-BR.md (+1 -1)

...and 10 more files

📄 Description

Summary

Third PR of the Kuna provider series. Depends on #3854 (#3832 has merged). Its base is #3854's branch, so the diff shows only the documentation, notices and catalog changes. Refs #1957.

It documents the Kuna provider and lists it in the generated product catalog. There is no runtime behavior change.

Problem and expected behavior

#3832 and #3854 add a Kuna provider, its settings and a real-provider lane. Users and agents need to find and configure it, know which tools it answers and where its answers come from, and maintainers need the lane documented and the provider in the catalog.

Change and scope

  • docs/kuna-provider.md:
    • Configuration: settings table, defaults, platforms and admitted targets.
    • The tools Kuna answers and their source.
    • Cold and warm answer paths, and raw_result.source.
    • Provenance and limitations.
    • Cache layout and ownership.
    • The verification lane.
  • Links:
    • README.md and all 19 translations link the guide next to the IDA guide. The documentation-link parity check requires this; "Kuna" is a proper noun, so no sentence was retranslated.
    • Also linked from docs/cli.md, docs/index.md, docs/installation.md and the site navigation.
  • docs/testing.md: a "Kuna lane" section covering npm run verify:kuna, its prerequisites, --targets, --compare-ghidra, and the first run's exact coverage and gaps.
  • THIRD_PARTY_NOTICES.md: a Kuna row (Apache-2.0, with links to its LICENSE and NOTICE at v1.833) stating that it is bring-your-own and never bundled. No license copy is vendored, because nothing is redistributed.
  • Agent skill (.agents/skills/reverse-engineer-anything/SKILL.md):
    • When to select kuna and what it cannot answer.
    • That cold answers can be single-function.
    • That raw_result.source names files agents may search directly.
    • Kuna added to the "never installs" lists.
  • Catalog generator (scripts/lib/catalog-core.mjs, catalog-builders.mjs): registers Kuna's identity and declared operations, so the generated docs/public/product-catalog.json lists provider kuna with its 8 operations. The catalog is a gitignored build output, regenerated by npm run docs:generate.

Contract and boundary impact

  • Semantic owner and earliest changed stage: documentation and catalog generation only.

  • Contribution scope fit and linked maintainer decision: documents the provider from #3854; the scope decision on #1957 is pending.

  • CLI and MCP/tool-catalog contract: the generated product catalog gains provider kuna. Tools are unchanged.

  • Provider, bridge, target-format, or platform compatibility: documented as in #3854.

  • Evidence, artifact, provenance, or reconstruction contract: none.

  • Target selection, authority, upstream behavior, and cleanup details: none.

  • 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: none. The existing documentation-fact, README-consistency and product-catalog tests cover this change.
  • Generated output: npm run docs:generate lists {"id":"kuna","name":"Kuna","version":null,"capabilities":["address_name","analyze_function","list_documents","list_procedures","procedure_address","procedure_assembly","procedure_pseudo_code","search_procedures"]}.
  • Remaining proof gaps: the translated READMEs only gain the link; their prose is not extended.

Validation performed

  • npm run docs:check — passed. Before the translations gained the link, it failed with "documentation links differ from README.md" for every translation.
  • npm run docs:build — passed. kuna-provider.html is built, with no dead links.
  • npm run test:focused -- tests/boundary/filesystem/productCatalog.test.ts tests/boundary/filesystem/documentationFacts.test.ts — 11 passed.
  • npm run check:fast, npm run format:check, npx knip — passed.
  • After rebasing onto #3854's rebased branch: npm run check:fast, npm run docs:check, npx knip, the Kuna boundary tests (79) and the catalog/documentation tests (11) — passed.

Compatibility, safety, and release

  • Breaking changes or migration steps: none.
  • Real Hopper/Ghidra, browser, or OS coverage: not applicable; the real-provider runs are reported in #3854.
  • Package or release metadata impact: the generated product catalog lists kuna.
  • Security, privacy, process, or containment review: the guide and the skill note that text read directly from cached export files is target-derived and bypasses the untrusted-content marker on tool results.

Author readiness

Human owner:

  • 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.

🤖 Generated with Claude Code


🔄 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/3855 **Author:** [@kaoru0822-kitauji](https://github.com/kaoru0822-kitauji) **Created:** 10/15/2026 **Status:** ✅ Merged **Merged:** 10/15/2026 **Merged by:** [@kaoru0822-kitauji](https://github.com/kaoru0822-kitauji) **Base:** `feat/kuna-provider` ← **Head:** `feat/kuna-docs` --- ### 📝 Commits (4) - [`5841ba6`](https://github.com/morluto/rea/commit/5841ba67716cc010e6f7033ebc9e773c3ce656c8) docs(kuna): document the Kuna provider and list it in the catalog - [`fa52fba`](https://github.com/morluto/rea/commit/fa52fbaeb7555cda2376b57aeb022db2ef4c74f1) docs(kuna): state the Linux cache fallback, raw_result scope and comparison inputs - [`1d4dba7`](https://github.com/morluto/rea/commit/1d4dba756946c81e08081b9a9e2116e19ede5564) docs(kuna): note that cache pins hold within one REA process - [`52921e4`](https://github.com/morluto/rea/commit/52921e48f9c8f76f08d8a143983eaa697487002f) docs(kuna): describe retired staging and retried cleanup ### 📊 Changes **30 files changed** (+156 additions, -32 deletions) <details> <summary>View changed files</summary> 📝 `.agents/skills/reverse-engineer-anything/SKILL.md` (+11 -2) 📝 `README.md` (+2 -1) 📝 `THIRD_PARTY_NOTICES.md` (+1 -0) 📝 `docs/.vitepress/config.ts` (+1 -0) 📝 `docs/cli.md` (+3 -2) 📝 `docs/index.md` (+1 -1) 📝 `docs/installation.md` (+7 -7) ➕ `docs/kuna-provider.md` (+80 -0) 📝 `docs/readme/README_ar.md` (+1 -1) 📝 `docs/readme/README_de.md` (+1 -1) 📝 `docs/readme/README_el.md` (+1 -1) 📝 `docs/readme/README_es.md` (+1 -1) 📝 `docs/readme/README_fa.md` (+1 -1) 📝 `docs/readme/README_fr.md` (+1 -1) 📝 `docs/readme/README_id.md` (+1 -1) 📝 `docs/readme/README_it.md` (+1 -1) 📝 `docs/readme/README_ja.md` (+1 -1) 📝 `docs/readme/README_ko.md` (+1 -1) 📝 `docs/readme/README_pl.md` (+1 -1) 📝 `docs/readme/README_pt-BR.md` (+1 -1) _...and 10 more files_ </details> ### 📄 Description ## Summary Third PR of the Kuna provider series. Depends on #3854 (#3832 has merged). Its base is #3854's branch, so the diff shows only the documentation, notices and catalog changes. Refs #1957. It documents the Kuna provider and lists it in the generated product catalog. There is no runtime behavior change. ## Problem and expected behavior #3832 and #3854 add a Kuna provider, its settings and a real-provider lane. Users and agents need to find and configure it, know which tools it answers and where its answers come from, and maintainers need the lane documented and the provider in the catalog. ## Change and scope - **`docs/kuna-provider.md`:** - Configuration: settings table, defaults, platforms and admitted targets. - The tools Kuna answers and their source. - Cold and warm answer paths, and `raw_result.source`. - Provenance and limitations. - Cache layout and ownership. - The verification lane. - **Links:** - `README.md` and all 19 translations link the guide next to the IDA guide. The documentation-link parity check requires this; "Kuna" is a proper noun, so no sentence was retranslated. - Also linked from `docs/cli.md`, `docs/index.md`, `docs/installation.md` and the site navigation. - **`docs/testing.md`:** a "Kuna lane" section covering `npm run verify:kuna`, its prerequisites, `--targets`, `--compare-ghidra`, and the first run's exact coverage and gaps. - **`THIRD_PARTY_NOTICES.md`:** a Kuna row (Apache-2.0, with links to its LICENSE and NOTICE at v1.833) stating that it is bring-your-own and never bundled. No license copy is vendored, because nothing is redistributed. - **Agent skill** (`.agents/skills/reverse-engineer-anything/SKILL.md`): - When to select `kuna` and what it cannot answer. - That cold answers can be single-function. - That `raw_result.source` names files agents may search directly. - Kuna added to the "never installs" lists. - **Catalog generator** (`scripts/lib/catalog-core.mjs`, `catalog-builders.mjs`): registers Kuna's identity and declared operations, so the generated `docs/public/product-catalog.json` lists provider `kuna` with its 8 operations. The catalog is a gitignored build output, regenerated by `npm run docs:generate`. ## Contract and boundary impact - **Semantic owner and earliest changed stage:** documentation and catalog generation only. - **Contribution scope fit and linked maintainer decision:** documents the provider from #3854; the scope decision on #1957 is pending. - **CLI and MCP/tool-catalog contract:** the generated product catalog gains provider `kuna`. Tools are unchanged. - **Provider, bridge, target-format, or platform compatibility:** documented as in #3854. - **Evidence, artifact, provenance, or reconstruction contract:** none. - **Target selection, authority, upstream behavior, and cleanup details:** none. - [ ] 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:** none. The existing documentation-fact, README-consistency and product-catalog tests cover this change. - **Generated output:** `npm run docs:generate` lists `{"id":"kuna","name":"Kuna","version":null,"capabilities":["address_name","analyze_function","list_documents","list_procedures","procedure_address","procedure_assembly","procedure_pseudo_code","search_procedures"]}`. - **Remaining proof gaps:** the translated READMEs only gain the link; their prose is not extended. ## Validation performed - `npm run docs:check` — passed. Before the translations gained the link, it failed with "documentation links differ from README.md" for every translation. - `npm run docs:build` — passed. `kuna-provider.html` is built, with no dead links. - `npm run test:focused -- tests/boundary/filesystem/productCatalog.test.ts tests/boundary/filesystem/documentationFacts.test.ts` — 11 passed. - `npm run check:fast`, `npm run format:check`, `npx knip` — passed. - After rebasing onto #3854's rebased branch: `npm run check:fast`, `npm run docs:check`, `npx knip`, the Kuna boundary tests (79) and the catalog/documentation tests (11) — passed. ## Compatibility, safety, and release - **Breaking changes or migration steps:** none. - **Real Hopper/Ghidra, browser, or OS coverage:** not applicable; the real-provider runs are reported in #3854. - **Package or release metadata impact:** the generated product catalog lists `kuna`. - **Security, privacy, process, or containment review:** the guide and the skill note that text read directly from cached export files is target-derived and bypasses the untrusted-content marker on tool results. ## Author readiness Human owner: <!-- @GitHub-handle --> - [ ] 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. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
bsakaguchi 2026-10-31 01:10:41 +00:00
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#5952
No description provided.