Skip to content

docs: optimize repository instructions for AI coding agents - #9

Merged
eflipper13 merged 1 commit into
mainfrom
eflipper13-agent-friendly-v3
Nov 18, 2026
Merged

eflipper13 merged 1 commit into
mainfrom
eflipper13-agent-friendly-v3

Conversation

@eflipper13

Copy link
Copy Markdown
Owner

Purpose

Reduce repeated repository discovery and instruction-context loading while preserving GhostNode Tools' safety and operational boundaries.

Verified problems addressed

  • The root agent instruction contract was 247 lines / 11,952 bytes and duplicated release, architecture, testing, and operational guidance.
  • Agents lacked a compact module and test-target map.
  • README did not provide a concise documentation index.
  • The prior audit's claimed missing CONFIGURATION.md and SECURITY.md findings were not reproducible; those files exist and remain the correct sources.

Files changed

  • AGENTS.md
  • CONTRIBUTING.md
  • README.md

Summary

  • Reduced AGENTS.md to 91 lines / 5,006 bytes.
  • Kept public/private safety, wallet, RPC, LAN, production, and Git boundaries explicit.
  • Added verified module and subsystem-to-test navigation to CONTRIBUTING.md.
  • Added a concise documentation index to README.md.
  • Preserved release history and version-metadata context without changing versions.

Verification

  • git diff --check: PASS
  • Tracked artifact policy: PASS
  • Changed-file allowlist: AGENTS.md, CONTRIBUTING.md, README.md only
  • All module-map targets and documentation references checked: PASS
  • No application code, CI, runtime, deployment, or package metadata changed
  • No full test suite run because this change is documentation-only

Security and production impact

  • No application behavior or public/private boundaries changed.
  • No production services, credentials, wallet data, or runtime configuration were accessed or modified.

Known limitations

This is a proposed documentation-only optimization. It may benefit from periodic link and test-map maintenance.

This PR is ready for human review and remains unmerged.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@eflipper13
eflipper13 merged commit 93f3d3d into main Nov 18, 2026
2 checks passed
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.

2 participants