docs: rewrite getting_started.md for presentation-ready format #74
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Update getting_started.md: fix "Next Steps" to reflect BP+OSD is available - Expand api_reference.md with comprehensive API documentation: - Add DEM functions (extract_dem, build_parity_check_matrix, build_decoding_uai) - Add BatchBPDecoder and BatchOSDDecoder documentation - Add Syndrome Database functions - Add Circuit Generation functions - Organize into logical sections
Restructure the getting started guide into 5 clear sections designed for a ~15 minute presentation: 1. The Decoding Problem - circuit-level noise, detection events 2. Pipeline Overview - Mermaid flowchart, DEM as rulebook 3. BP Algorithm & Why It Fails - factor graph, degeneracy problem 4. OSD Post-Processing - OSD-0 algorithm, soft-weighted cost 5. Live Demo - minimal code example, threshold results Key changes: - Reduced from 493 to 280 lines - Added 3 Mermaid flowcharts for visual understanding - Condensed code examples to essential snippets - Corrected threshold values (BP+OSD ~0.7%, not ~10%) - Moved detailed CLI options to usage_guide.md - Removed troubleshooting and advanced usage sections
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #74 +/- ##
=======================================
Coverage 96.84% 96.84%
=======================================
Files 10 10
Lines 728 728
=======================================
Hits 705 705
Misses 23 23
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Structure
Removed Content (relocated to other docs)
Test Plan