docs: deeper structural improvements#5
Conversation
… report formats, exit codes, OF bindings - Merge reference/exit-codes.md into cli/exit-codes.md: full table, per-command matrix, why-exit-1 explanation, CI YAML example, stability guarantee. Deleted the redundant reference page (sidebar update needed separately). - Expand how-flaglint-works.md: import-verified concept with false-positive example, three-phase pipeline explanation, what FlagLint does not do. - Expand troubleshooting.md: 4 items → 8 items covering 0-flags-detected, config-not-found, React-not-automigrated, apply-0-transformed, validate-CI-gap. - Rewrite report-formats.md: format comparison table, when-to-use prose for each format, GitHub Code Scanning SARIF upload example. - Expand configuration.md openFeatureClientBindings: what it does, example, multiple bindings, difference from wrappers. Signed-off-by: Krishan Kant Sharma <krishansharma0327@gmail.com>
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (35)
📝 WalkthroughWalkthroughThis PR is a documentation-only update across the flaglint.dev docs site. It rewrites exit-code semantics, expands CLI configuration and report-format documentation, revises the analysis pipeline narrative, adds troubleshooting scenarios, updates command examples to npx flaglint@latest, and repoints "Edit this page on GitHub" links to the new flaglint.dev repository path. ChangesDocumentation content and link updates
Estimated code review effort: 2 (Simple) | ~15 minutes Possibly related PRs
Poem
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Summary
Deeper structural improvements from the expert docs audit — expands thin pages, merges duplicates, and adds missing reference content.
Exit codes — merged duplicate pages
cli/exit-codes.mdis now the complete authoritative page: full table (0/1/2/3/130), per-command matrix, CI YAML example, stability guaranteereference/exit-codes.mddeleted (was a duplicate)How FlagLint works — major expansion
variation()from an animation library is never flaggedTroubleshooting — 4 items → 9 items
Added: "0 flags detected", "Config file not found", "React patterns not auto-migrated", "
--applyshows 0 transformed", "validate passes locally but fails in CI"Report formats — full rewrite
openFeatureClientBindings — proper documentation
Test plan
Summary by CodeRabbit
Documentation
Bug Fixes