docs: AGENTS.md as canonical repo guide; CLAUDE.md points to it#56
Merged
Conversation
- Untrack-ignore + commit CLAUDE.md as a one-line pointer to AGENTS.md so the redirect is shared (single source of truth for all agents). - Fold the CLAUDE.md version-bump rules into AGENTS.md. - Fix AGENTS.md inaccuracies: targets .NET 10 (NNark libs .NET 8) not '.NET 8 everything'; Structure now reflects real projects (BTCPayServer.Plugins.ArkPayServer, submodules/NNark, NArk.E2E.Tests, NArk.sln) instead of the non-existent NArk / NArk.Grpc / NArk/Boltz; drop stale 'early-stage, most components not yet built' framing — the plugin ships BTC/Lightning(Boltz)/boarding/asset flows.
Contributor
There was a problem hiding this comment.
✅ Docs-only — LGTM
Verified every factual claim against the repo:
- TFMs: Plugin + E2E tests →
net10.0✔︎, NNark SDK libs (NArk.Core,NArk.Abstractions,NArk.Swaps,NArk.Storage.EfCore) →net8.0✔︎ - Structure: All listed projects exist. Old phantom entries (
NArk,NArk.Grpc,NArk/Boltz) correctly removed. - setup.sh: Submodules → workloads →
DEBUG_PLUGINSappsettings → publish. Matches description.start-test-env.cmdexists. - NArk.E2E.Tests: Present at root, not in
NArk.sln— consistent with "runs in thee2eCI workflow" note. .gitignore: RemovingCLAUDE.mdfrom ignore makes sense now that it's a tracked one-line pointer.- CLAUDE.md: Single-line redirect to
AGENTS.md— clean canonical-source pattern. - Version-bump rules: Folded into AGENTS.md so they're not lost in a gitignored file. Good.
- Tense fixes ("will integrate" → "integrates", dropping "early-stage" framing): Accurate — the plugin ships these flows today.
No protocol-critical changes. No code changes. No cross-repo impact.
One minor nit (non-blocking): AGENTS.md:4 says "NNark SDK libraries" but the submodule directory and all project names use NArk.*. The repo name on GitHub is arkade-os/dotnet-sdk and the directory is submodules/NNark. Might be worth a parenthetical clarifying that "NNark" is the submodule/repo name while NArk.* are the .NET project names, to avoid confusion for new contributors. Take it or leave it.
🤖 Reviewed by Arkana
This was referenced May 19, 2026
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Make AGENTS.md the canonical repo guide
CLAUDE.mdwas gitignored (local-only) andAGENTS.mdwas stale. This makes AGENTS.md the single source of truth and turnsCLAUDE.mdinto a tracked one-line pointer to it, so every agent/tool reads the same guide.Changes
.gitignore: stop ignoringCLAUDE.md(kept.claude/ignored).CLAUDE.md: now a one-line pointer toAGENTS.md(tracked).AGENTS.md:setup.shDEBUG_PLUGINSnet10.0 path + csproj TFMs).BTCPayServer.Plugins.ArkPayServer,submodules/NNark(NArk.Core/NArk.Abstractions/NArk.Swaps/NArk.Storage.EfCore),submodules/btcpayserver,NArk.E2E.Tests,NArk.sln. Removed the non-existentNArk,NArk.Grpc(Protos/ark/v1), andNArk/Boltzprojects.setup.shactually does (+start-test-env.cmd).Docs-only; no code changes. Separate from the asset PR (#55) per request.