Skip to content

docs: restructure AGENTS.md to match retrieved file layout#269

Merged
avoidwork merged 1 commit intomasterfrom
docs/restructure-agents-md
May 10, 2026
Merged

docs: restructure AGENTS.md to match retrieved file layout#269
avoidwork merged 1 commit intomasterfrom
docs/restructure-agents-md

Conversation

@avoidwork
Copy link
Copy Markdown
Owner

Summary

  • Restructured AGENTS.md to match the section hierarchy of the retrieved file from avoidwork/AGENTS.md
  • Mapped existing sections to numbered hierarchy (1–9) while preserving all project-specific content
  • Key structural changes:
    • Consolidated fragmented sections under numbered headings
    • Moved modification details to API Reference (5.4)
    • Renamed Python Conventions → JavaScript Conventions
    • Renamed Framework Conventions → Core Architecture (project-specific)
    • Removed non-applicable sections (Session Learnings, Troubleshooting, Quick Reference)

@augmentcode
Copy link
Copy Markdown

augmentcode Bot commented May 10, 2026

🤖 Augment PR Summary

Summary: This PR reorganizes AGENTS.md into a numbered, hierarchical document to align with the layout used in the upstream/retrieved guidelines.

Changes:

  • Renames and rehomes sections into a 1–9 outline (Core Rules, Project Context, JS Conventions, Core Architecture, API Reference, Patterns, Git, Ops, Checklist)
  • Adds/clarifies security and forbidden-pattern guidance (OWASP-focused, no network requests, no code execution)
  • Introduces an “Expected Project Layout” block and a Quick Commands table
  • Moves the partial() immutability/destructuring guidance into the API Reference section
  • Consolidates testing/coverage and build/distribution details under Operational Rules
  • Updates terminology (Python/Framework conventions → JavaScript Conventions / Core Architecture)
  • Removes/omits previously separate Troubleshooting/Quick Reference/Session Learnings sections in favor of the new structure

Technical Notes: No runtime code changes; this is a documentation-only restructure intended to make agent guidance easier to navigate and reference.

🤖 Was this summary useful? React with 👍 or 👎

Copy link
Copy Markdown

@augmentcode augmentcode Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review completed. 3 suggestions posted.

Fix All in Augment

Comment augment review to trigger a new review at any time.

Comment thread AGENTS.md
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md
@avoidwork avoidwork force-pushed the docs/restructure-agents-md branch from d21d162 to c5c238e Compare May 10, 2026 12:30
@avoidwork avoidwork force-pushed the docs/restructure-agents-md branch from c5c238e to 133e74c Compare May 10, 2026 12:32
@avoidwork avoidwork merged commit 5311f32 into master May 10, 2026
2 checks passed
@avoidwork avoidwork deleted the docs/restructure-agents-md branch May 10, 2026 12:33
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