Skip to content

OAK-12136 : add AGENTS.md for oak-store-document module#2797

Merged
rishabhdaim merged 4 commits intotrunkfrom
OAK-12136
Mar 16, 2026
Merged

OAK-12136 : add AGENTS.md for oak-store-document module#2797
rishabhdaim merged 4 commits intotrunkfrom
OAK-12136

Conversation

@rishabhdaim
Copy link
Contributor

Summary

Adds a dedicated AGENTS.md for the oak-store-document module, following the format established in #2775 (oak-segment-tar/AGENTS.md).

The file covers:

  • Module overview with 3 backends (MongoDB, RDB, Memory)
  • Key Concepts: storage model, revision model, MVCC, branching, split documents, sweep
  • Package layout and key classes
  • OSGi configuration wiring chain
  • Background operations and caching
  • Garbage Collection (Revision GC + Full GC with FullGCMode enum and OSGi config)
  • Throttling (MongoDB only, MongoThrottlerFactory types)
  • Lease Updates (LeaseCheckMode, key classes, OSGi config)
  • Secondary Store, Checkpoints, Prefetch, Persistent Cache
  • DocumentDiscoveryLiteService
  • Feature Toggles table (9 toggles)
  • Cluster Support, System Properties
  • Testing guide (3 backends, build commands)
  • Common Pitfalls

Changes

  • oak-store-document/AGENTS.md — new file

Test Plan

  • No code changes; documentation only

Links

@rishabhdaim rishabhdaim requested a review from reschke March 16, 2026 08:49
@rishabhdaim rishabhdaim self-assigned this Mar 16, 2026
@rishabhdaim rishabhdaim requested a review from mbaedke March 16, 2026 08:51
@sonarqubecloud
Copy link

@rishabhdaim rishabhdaim merged commit d7a4f19 into trunk Mar 16, 2026
3 checks passed
@rishabhdaim rishabhdaim deleted the OAK-12136 branch March 16, 2026 16:19
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.

2 participants