Skip to content

docs: add ARCHITECTURE.md and link from AGENTS.md#479

Merged
JoshMock merged 1 commit into
mainfrom
arch-notes
Jul 14, 2026
Merged

docs: add ARCHITECTURE.md and link from AGENTS.md#479
JoshMock merged 1 commit into
mainfrom
arch-notes

Conversation

@JoshMock

Copy link
Copy Markdown
Member

I did a full audit of the codebase using ponytail, and all the recommendations it suggested were simplifications of the code that would introduce performance regressions. Fixing those regressions is why the code complexity was introduced in the first place.

So, I've added an ARCHITECTURE.md file, linked from AGENTS.md, that explains each architectural choice, why it exists, and why it should not be removed, unless the improvement can avoid a perf regression.

@github-actions

Copy link
Copy Markdown
Contributor

MegaLinter analysis: Success

Descriptor Linter Files Fixed Errors Warnings Elapsed time
✅ COPYPASTE jscpd yes no no 0.62s
✅ REPOSITORY gitleaks yes no no 34.43s
✅ REPOSITORY git_diff yes no no 0.23s
✅ REPOSITORY secretlint yes no no 16.76s
✅ REPOSITORY trivy yes no no 9.91s

Notices

📣 MegaLinter 9.5.0 is out! Discover the new features and security recommendations in the release announcement. (Skip this info by defining SECURITY_SUGGESTIONS: false)

See detailed reports in MegaLinter artifacts
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

MegaLinter is graciously provided by OX Security
Show us your support by starring ⭐ the repository

@JoshMock JoshMock merged commit b609121 into main Jul 14, 2026
27 of 28 checks passed
@JoshMock JoshMock deleted the arch-notes branch July 14, 2026 21:29
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