Skip to content

chore(docs): refresh AGENTS.md and native codebase audit#388

Merged
manusa merged 3 commits into
mainfrom
chore/refresh-agent-docs
May 21, 2026
Merged

chore(docs): refresh AGENTS.md and native codebase audit#388
manusa merged 3 commits into
mainfrom
chore/refresh-agent-docs

Conversation

@manusa
Copy link
Copy Markdown
Owner

@manusa manusa commented May 21, 2026

Summary

Refresh of the agent-facing docs in this repo.

The move is done as a pure rename commit (100% similarity), so git log --follow docs/research/native-codebase-audit.md traces history through to the original ANALYSIS.md.

Test plan

  • Sanity-check rendered Markdown for both files on GitHub
  • git log --follow docs/research/native-codebase-audit.md reaches the original ANALYSIS.md history

manusa and others added 3 commits May 21, 2026 09:59
Pure rename to align with the docs/research/ layout convention. Content
rewrite follows in the next commit so git rename detection holds.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Signed-off-by: Marc Nuri <marc@marcnuri.com>
Re-verified findings against current HEAD. Updates since 2025-11-14:
status/history/get-values shipped (PRs #345/#352/#353), NewCfg panic
fixed, newRegistryClient extraction done. Still open: install/upgrade
defer cancel() leak, three TODOs (helm.go, search.go, repotest.go),
and rollback/pull commands (#101, #351).

Restructured to match docs/research conventions: dated header with
related issue/PR links, TL;DR, status-of-prior-findings table.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Signed-off-by: Marc Nuri <marc@marcnuri.com>
Fix factual errors and gaps that would mislead agents working in the
repo:

- Correct Go version (1.25.7, not 1.25.0+)
- Replace inaccurate native/ tree: real Go logic lives in
  native/internal/helm/, not native/main.go (which is a CGO bridge only)
- Replace ad-hoc file enumerations with a role-based table driven by the
  naming conventions, so it doesn't go stale on every new command
- Document SPI-based native library loading (ServiceLoader +
  RemoteJarLoader fallback) and OS-activated Maven profiles
- Document static-vs-instance API duality on Helm.java
- Document CI Java-version split (8 on Linux, 11 on macOS/Windows)
- Add missing Makefile targets (test-go, update-go-deps, license,
  release, build-native-wasi)
- Fix the "Adding a New Helm Command" workflow to point at
  internal/helm/<verb>.go, not main.go
- Mark lib/wasi/ and native/wasm/ as abandoned (issue #239)
- Replace stale ANALYSIS.md pointer with link to refreshed audit
- Add call-flow diagram so agents can hold the JNA → CGO → Go path in
  their head

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Signed-off-by: Marc Nuri <marc@marcnuri.com>
@manusa manusa force-pushed the chore/refresh-agent-docs branch from af04708 to a470f2a Compare May 21, 2026 08:17
@manusa manusa merged commit 9b20db6 into main May 21, 2026
3 checks passed
@manusa manusa deleted the chore/refresh-agent-docs branch May 21, 2026 08:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant