Files
logpile/bible-local/README.md
Mikhail ChusavitinandClaude Opus 5.5 cb2e38223e chore: update parser module to v38.0.0, script parser bumps
Move logpile to git.mchus.pro/reanimator/parser/v38 v38.0.0 (ADL-085).
Add scripts/bump-parser.sh, which bumps the parser, tests, commits, tags
the release as v<counter>.<parser major>, pushes and builds (ADL-086).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-26 18:07:28 +03:00

45 lines
2.0 KiB
Markdown

# LOGPile Bible
`bible-local/` is the project-specific source of truth for LOGPile.
Keep top-level docs minimal and put maintained architecture/API contracts here.
## Rules
- Documentation language: English only
- Update relevant bible files in the same change as the code
- Record significant architectural decisions in [`10-decisions.md`](10-decisions.md)
- Do not duplicate shared rules from `bible/`
## Read order
| File | Purpose |
|------|---------|
| [01-overview.md](01-overview.md) | Product scope, modes, non-goals |
| [02-architecture.md](02-architecture.md) | Runtime structure, state, main flows |
| [04-data-models.md](04-data-models.md) | Stable data contracts and canonical inventory |
| [03-api.md](03-api.md) | HTTP endpoints and response contracts |
| [05-collectors.md](05-collectors.md) | Live collection behavior |
| [06-parsers.md](06-parsers.md) | Archive parser framework and vendor coverage |
| [07-exporters.md](07-exporters.md) | Raw export, Reanimator export, batch convert |
| [docs/hardware-ingest-contract.md](docs/hardware-ingest-contract.md) | Reanimator ingest schema mirrored locally |
| [docs/privacy-scan.md](docs/privacy-scan.md) | Customer-data / anonymization scan of ingested sources |
| [docs/log-sanitization.md](docs/log-sanitization.md) | In-place, length-preserving redaction of customer data |
| [08-build-release.md](08-build-release.md) | Build and release workflow |
| [09-testing.md](09-testing.md) | Test expectations and regression rules |
| [10-decisions.md](10-decisions.md) | Architectural Decision Log |
## Fast orientation
- Entry point: `cmd/logpile/main.go`
- HTTP layer: `internal/server/`
- Core contracts: `git.mchus.pro/reanimator/parser/v38/models`
- Live collection: `internal/collector/`
- Archive parsing and Redfish analysis: external module `git.mchus.pro/reanimator/parser/v38` (see `06-parsers.md`)
- Export conversion: `internal/exporter/`
- Frontend consumer: `web/static/js/app.js`
## Maintenance rule
If a document becomes stale, either fix it immediately or delete it.
Stale docs are worse than missing docs.