Skip to content

docs: add AGENTS.md and CLAUDE.md #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Alex-Arsys wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add AGENTS.md and CLAUDE.md #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# core-fonts — Euro-Office Font Infrastructure

@../AGENTS.md

Guidance for Claude Code (and other AI agents) working in **core-fonts** — the font binary asset store.

## What this repo is
A static, no-build collection of font binaries (`.ttf`/`.otf`/`.ttc`) across 40+ vendor families (Liberation, DejaVu, Droid, Noto, Lohit, …), plus `ASC.ttf` (the Euro-Office Private Use Area font with internal symbols). It contains **no code and no build step** — it is consumed by tooling that lives in other repos.

## How fonts flow into the build
- **`AllFonts.js` is generated by `core`, not here.** The `core/DesktopEditor/AllFontsGen/` C++ tool parses every font in this repo and emits `AllFonts.js` (metrics + charset maps + fallback chains) into the `sdkjs` source tree. **CRITICAL:** if you add or replace a font binary, `AllFonts.js` must be regenerated in `core` and rebuilt in `sdkjs` — the change is invisible to the editors until then.
- **Production path:** packaging copies this tree to `/var/www/euro-office/documentserver/core-fonts/` (see `build/build_deb.sh`). Tooling resolves fonts from that fixed path — do not restructure the directory layout.
- **Fallback order** is derived from font metadata by `AllFontsGen` at generation time, not from any config file in this repo.

## Rules
- **Never** edit font binaries by hand — each vendor has its own license file; binary edits void it and corrupt the font.
- **Never** remove `ASC.ttf` — the rendering engine depends on its Private Use Area codepoints.
- **Never** add a font without verifying its license permits free redistribution, and without including the vendor's license file.
- **Never** commit `AllFonts.js` here — it is generated output that belongs to `sdkjs`.

## Findings & Long-tail
No centralized findings store exists in this repository yet. Document edge cases in code comments or GitHub issues until one is established.
1 change: 1 addition & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@AGENTS.md