docs: add AGENTS.md and CLAUDE.md#112
Conversation
Alex-Arsys
requested review from
DmySyz and
chrip
and removed request for
a team
| ## What this repo is | ||
| A monolithic C++ library implementing document format conversion (X2T CLI: DOC/DOCX ↔ ODF/PDF/HTML/EPUB/XPS/DjVu/…), font metrics generation (AllFontsGen), headless rendering (DocRenderer), document scripting (doctrenderer), and WASM modules (fonts, spell, zlib, hash, drawingfile). Lowest layer of the stack — everything else depends on its output. Fork of `ONLYOFFICE/core`. Licensed **AGPL-3.0**. | ||
|
|
||
| ## Build Architecture & Critical Dependencies |
There was a problem hiding this comment.
I think it would make sense to document build steps for the binaries and modules in some way so agents can pick up and verify passing build and changes locally.
| ## Rules | ||
| - **Never** hand-edit vendored third-party sources in `Common/3dParty/` or `DesktopEditor/agg-2.4/`. For vcpkg-managed dependencies (ICU, Boost, OpenSSL, HarfBuzz, hunspell), bump `vcpkg.json` instead of patching. | ||
| - **Never** commit the `build/` output directory or compiled binaries. | ||
| - **Never** run CI without `NUGET_CACHE` — cold build takes ~5 hours. |
There was a problem hiding this comment.
I see no sense in adding that. There is no obvious way to trigger a ci run without the cache.
|
I don't have much experience with agent files. The info outlined looks sane to me. We can extend as it goes. |
Alex-Arsys
force-pushed
the
docs/add-claude-md
branch
from
f4199cc to
677295a
Compare
chrip
left a comment
chrip
left a comment
There was a problem hiding this comment.
Requesting changes — the build-steps section (addressing Julius's note) and the #51 removal are good improvements. Two factual issues I hit while verifying against the tree, plus one leftover:
1. The vcpkg dependency list is inaccurate.
"For vcpkg-managed dependencies (ICU, Boost, OpenSSL, HarfBuzz, hunspell), bump
vcpkg.jsoninstead of patching."
The root vcpkg.json only declares hunspell. ICU, OpenSSL and HarfBuzz are vendored sources under Common/3dParty/ (built via build_3rdparty.py) and aren't in any vcpkg.json; Boost is vcpkg-managed but through a nested Common/3dParty/boost/vcpkg.json. As written this contradicts the bullet directly above it ("Never hand-edit vendored sources in Common/3dParty/"). Suggest narrowing the vcpkg example to what's actually manifest-managed (hunspell, Boost) and treating ICU/OpenSSL/HarfBuzz as vendored.
2. DocRenderer doesn't exist in this repo. I think you mean DocxRenderer (the headless renderer at the repo root). AllFontsGen and doctrenderer check out (both under DesktopEditor/).
3. Leftover from the CI-cache discussion: the Rules bullet was dropped 👍, but the "vcpkg binary cache" bullet still says "CRITICAL FAIL MODE: Running CI without it wastes hours and risks timeouts." Per Julius's point that there's no obvious way to trigger CI without the cache, I'd keep the useful ~5h cold-build fact but drop the "running CI without it" framing.
Non-blocking: couldn't verify make core/* from this repo (no Makefile here — they live at the workspace level per ../AGENTS.md); just confirm make core/allfontsgen is a real target. Once 1–2 are fixed this is good to merge.
Assisted-by: Claude Code (Opus 4.8)
AGENTS.md is the canonical guidance file for AI agents working in this repository — covering architecture constraints, conventions, and rules. CLAUDE.md contains only `@AGENTS.md`, making Claude Code load this file automatically alongside other AI tools. Assisted-by: ClaudeCode:claude-sonnet-4-6 Signed-off-by: Alex Hernández <ahmartin@arsys.es>
Alex-Arsys
force-pushed
the
docs/add-claude-md
branch
from
677295a to
ee7fc4b
Compare
4 participants
AGENTS.md is the canonical guidance file for AI agents working in this repository — covering architecture constraints, conventions, and rules. CLAUDE.md contains only
@AGENTS.md, making Claude Code load this file automatically alongside other AI tools.Assisted-by: ClaudeCode:claude-sonnet-4-6