Task · OPN-0010

docs/flow.md flag table shows 10x-stale defaults for --flow.top-n and --flow.max-keys

Description

docs/flow.md:35-36 shows --flow.top-n/--flow.max-keys defaults as 1000/2500; code defaults are 10000/100000 (internal/options/flow.go:81,93). docs/configuration.md (docgen-owned) agrees with code, so only the hand-written flow.md table drifted. Operators reading flow.md underestimate default cardinality/memory by 10x. Consider making that table docgen-owned so it cannot drift again.

Acceptance Criteria

Definition of Done

Implementation Plan

Verify the live flow defaults, make the hand-written table non-drifting with the narrowest existing documentation mechanism, and validate the documentation gate.

Implementation Notes

Wave 1 staged WIP corrects the flow defaults to 10000 and 100000 and adds a documentation drift guard. docs-check and the integrated just check passed; post-correction L14 verified the values and guard. Not landed because the shared code-bearing batch lacks a complete CodeRabbit review. Resume: after CodeRabbit clears the staged batch, commit this documentation task with explicit pathspecs, integrate current origin/main, rerun the gate, push, and verify exact-SHA CI.

Landed as cdf2b1dadf6e84bdc71d9a987d2cbd3a6435b949. Focused scripts/docgen tests and just docs-check passed; integrated just check passed. CodeRabbit completed with zero findings across docs/flow.md and scripts/docgen/doclint_test.go. Exact-head CI run 33577476675 completed successfully.

Final Summary

Corrected docs/flow.md to the 10000 top-N and 100000 max-keys defaults and added a doclint regression check against the live flag model. Verified with focused doc tests, just docs-check, just check, zero-finding CodeRabbit review, and exact-head CI run 33577476675. Commit: cdf2b1dadf6e84bdc71d9a987d2cbd3a6435b949.

View the source file on GitHub