mirror of
https://github.com/mehah/otclient
synced 2026-08-15 16:29:06 -04:00
cec65014fc
Document the repository AGENTS.md loading budget and keep detailed workflows outside the always-loaded instruction file. Main changes: - Add an AGENTS.md Loading Budget section. - Keep the root AGENTS.md focused on repository-wide invariants and precise routing gates. - Direct detailed workflows to versioned documentation or reusable skills instead of expanding the root instruction file. - Document that Codex applies a combined instruction budget across global, root, and nested guidance. - Record the default 32 KiB instruction limit and recommend preserving headroom for narrower scoped instructions. - Keep mandatory gates near the beginning of the instruction chain. - Recommend removing duplicated guidance and routing conditional details before increasing project_doc_max_bytes. - Preserve the existing client-assets routing contract and documentation reference unchanged. Validation: - Audited the effective global and repository instruction chain at 11,106 bytes. - Verified the instruction chain remains below the 24 KiB maintenance target and default Codex limit. - Verified the existing client-assets documentation route remains valid. - Reviewed the complete committed diff. - Ran Git whitespace validation successfully. - No build was run because this is a documentation-only change. This keeps repository instructions concise and scalable while preserving room for nested guidance and avoiding unnecessary duplication in the always-loaded AGENTS.md.
33 lines
1.5 KiB
Markdown
33 lines
1.5 KiB
Markdown
# AGENTS.md
|
|
|
|
## AGENTS.md Loading Budget
|
|
|
|
- Keep this root file limited to repository-wide invariants and precise routing gates; place detailed workflows in versioned documentation or skills.
|
|
- Codex applies a combined instruction budget (32 KiB by default) across global, root, and nested guidance. Keep mandatory gates first and preserve headroom for narrower scopes.
|
|
- Do not raise `project_doc_max_bytes` as the first response to oversized guidance; remove duplication and route conditional detail first.
|
|
|
|
## Client Assets Gate (Mandatory)
|
|
|
|
Any change touching client-assets auto-installation must preserve the runtime contract below:
|
|
|
|
1. **Final install paths must remain OTC-standard**
|
|
- `data/things/<version>/`
|
|
- `data/sounds/<version>/`
|
|
- runtime extras in expected runtime locations (for example `bin/*` when distributed upstream)
|
|
|
|
2. **No alternate permanent source of truth**
|
|
- Do not move runtime loading to `client-assets/` (or any new root) as the primary runtime path.
|
|
- Temporary/cache directories are allowed only as transient staging, never as final runtime source.
|
|
|
|
3. **Security defaults stay strict unless explicitly justified**
|
|
- `strictManifestSha256 = true`
|
|
- `allowRawFallbackHashMismatch = false`
|
|
|
|
4. **Cross-platform build safety**
|
|
- Android must not require unsupported `libarchive` linkage.
|
|
- Desktop archive extraction behavior must remain functional.
|
|
|
|
5. **Verification required in PR description**
|
|
- Explicitly state tested install paths and expected runtime load behavior.
|
|
|
|
Reference: `docs/client-assets-auto-install.md`
|