Skip to content

Document remaining corpus crates in-line - #47

Merged
haasonsaas merged 1 commit into
mainfrom
docs/rest-of-codebase-inline
Aug 4, 2026
Merged

Document remaining corpus crates in-line#47
haasonsaas merged 1 commit into
mainfrom
docs/rest-of-codebase-inline

Conversation

@haasonsaas

Copy link
Copy Markdown
Contributor

Summary

Follow-up to #46: deep in-line documentation for the rest of the codebase (not only similarity).

  • corpus-core: module docs for ingest, hunts, agents, mtls, auth, scan, sandbox, registry, continuous, triggers, opinions, analyst, report, investigate, intel, oci, detonate, merlin, dto, error, db, hash, classify, metrics, detect, rules, tenant, byte-similarity edges/extract/fuzzy/lsh, semantic extract/fixtures
  • corpus-agent: main runtime loops, state, capture, stable_read, sensors, spool crypto
  • corpus-server / corpusctl / corpus-scanner: crate-level purpose and auth surfaces
  • Tests & migrations: module headers and migration summaries
  • Public function/struct docs on key APIs

Test plan

  • cargo fmt --all
  • cargo check --workspace
  • cargo test -p corpus-core --lib (95)
  • cargo test -p corpus-agent (skip known-flaky local stable_read)

Expand module-level rustdoc across corpus-core domain modules (ingest,
hunts, agents, scan, registry, …), corpus-agent sensors/runtime, server
and CLI entrypoints, integration tests, migrations, and key public APIs.
Comment-only; no behavior change.
@haasonsaas
haasonsaas merged commit bc8b7ac into main Aug 4, 2026
5 checks passed
@haasonsaas
haasonsaas deleted the docs/rest-of-codebase-inline branch August 4, 2026 16:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant