docs: add AGENTS.md and reorganize project documentation - #6871
SeriousCoding789 wants to merge 23 commits into
Conversation
|
Two issues and one optional naming nit as below, please consider whether modifications are required.:
|
very good suggestion, will fix all. |
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
- Note the build fails fast on a JDK/arch mismatch - Scope the lint helper comment to framework main - Fix the generated-protobuf source path (core/, api/ subdirs) - Add the platform module (arch-specific source sets) to the layout - List both plugins jars (Toolkit, ArchiveManifest)
# Conflicts: # start.sh # start.sh.simple
0ca52e5 to
6266117
Compare
What does this PR do?
AGENTS.md— a build/test/architecture guide for AI coding assistants and new contributors, covering the pre-commit checklist that mirrors the CI gates, the module dependency rules, and the invariants that must not be broken.docs/with consistent kebab-case names; marks two 2022-era protocol copies as superseded.start.sh,start.sh.simple,shell.md) — they are no longer maintained; node deployment is covered by the Docker image and is handed over totron-deployment..codeclimate.yml,sonar-project.properties, stale Sonar entries in the dependency verification metadata) and the.dockerignorefile.Why are these changes required?
java.lang.Mathprohibition, thereference.confschema and comment checks, dependency verification) were undocumented, so a contributor could only discover them by failing a build..codeclimate.ymlandsonar-project.propertiesare no longer used by CI.This PR has been tested by:
AGENTS.mdagainst the build configuration and sources, including running each command in the pre-commit checklist; confirmed all moved paths and cross-document links resolveFollow up
None.
Extra details