John McCardle
54624b353d
Rendered/generated documentation no longer lives in git -- it's regenerated by a pre-commit hook (tools/hooks/pre-commit, installed via `make install-hooks`) and shipped inside release artifacts (tools/package.sh) instead. A compact api/manifest.json (signatures + docstring hashes + carried-forward lifecycle metadata: since/modified per object and member) is the one exception and stays committed, refreshed by the same hook, so API changes remain trackable by commit/tag via `git show <ref>:api/manifest.json` and `tools/api_delta.py REF1 REF2` without needing a full rebuild at old refs. - tools/generate_api_manifest.py: engine-side introspection, run headless; emits api/manifest.json (committed) and docs/generated/api_full.json (gitignored, full docstrings -- the docs-site generator's data source). - tools/api_delta.py: stdlib-only diff CLI (md/json/gitea-checklist formats), with --site-dir to cross-reference affected docs-site pages via their mcrf frontmatter. - tools/hooks/pre-commit: incremental build + frozen-docstring gate + doc regen + manifest refresh, gated on staged src/ changes. - .gitignore covers the rendered docs/stubs plus personal working-notes docs (plans, audits, research write-ups) that were never McRogueFace-user-facing. - docs/api-stability.md and docs/threading-model.md removed: their content is now the wiki's "API Stability Contract" and "Threading Model" system pages (ratified 2026-07-02, migration verified 2026-07-11); the repo continues to enforce them via tests/unit/api_surface_snapshot_test.py. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
84 lines
1.7 KiB
Text
84 lines
1.7 KiB
Text
*.swp
|
|
*.swo
|
|
bin
|
|
.msvc-intermediate/
|
|
*.bak*
|
|
PCbuild
|
|
.vs
|
|
obj
|
|
build
|
|
/lib
|
|
__pycache__
|
|
|
|
# unimportant files that won't pass clean dir check
|
|
build*
|
|
docs
|
|
.claude
|
|
my_games
|
|
|
|
# images are produced by many tests
|
|
*.png
|
|
|
|
# WASM stdlib for Emscripten build
|
|
!wasm_stdlib/
|
|
|
|
.cache/
|
|
7DRL2025 Release/
|
|
CMakeFiles/
|
|
Makefile
|
|
*.zip
|
|
__lib/
|
|
__lib_debug/
|
|
__lib_windows/
|
|
build-windows/
|
|
build_windows/
|
|
_oldscripts/
|
|
|
|
# Audit tooling virtualenv (tools/audit_pymethoddef.py)
|
|
.venv-audit/
|
|
assets/
|
|
cellular_automata_fire/
|
|
deps/
|
|
fetch_issues_txt.py
|
|
forest_fire_CA.py
|
|
mcrogueface.github.io
|
|
scripts/
|
|
tcod_reference
|
|
.archive
|
|
.mcp.json
|
|
dist/
|
|
|
|
# Keep important documentation and tests
|
|
!CLAUDE.md
|
|
!README.md
|
|
!tests/
|
|
|
|
# Fuzzing build artifacts and runtime data (build-fuzz matched by build* above)
|
|
tests/fuzz/corpora/
|
|
tests/fuzz/crashes/
|
|
|
|
# >>> generated-docs (untrack via tools/untrack_generated_docs.sh) >>>
|
|
# Rendered/generated documentation is regenerated by the pre-commit hook and
|
|
# shipped inside release artifacts -- it no longer lives in git. The compact
|
|
# api/manifest.json is the exception: it STAYS committed (refreshed by the hook).
|
|
# Personal-notes docs (plans, triage, research) are also untracked here.
|
|
# tools/untrack_generated_docs.sh reads exactly this block to migrate the
|
|
# currently-tracked copies out of the index.
|
|
docs/API_REFERENCE_DYNAMIC.md
|
|
docs/api_reference_dynamic.html
|
|
docs/mcrfpy.3
|
|
stubs/mcrfpy.pyi
|
|
docs/generated/
|
|
docs/API_REFERENCE_COMPLETE.md
|
|
docs/api_reference_complete.html
|
|
docs/VISION.md
|
|
docs/GAMES.md
|
|
docs/plan-*.md
|
|
docs/api-audit-*.md
|
|
docs/ISSUE_TRIAGE_*.md
|
|
docs/GRID_ENTITY_OVERHAUL_ROADMAP.md
|
|
docs/sprint-*.md
|
|
docs/EMSCRIPTEN_RESEARCH.md
|
|
docs/WASM_TROUBLESHOOTING.md
|
|
docs/MCROGUFACE_LITE_PICOCALC_RESEARCH.md
|
|
# <<< generated-docs <<<
|