docs: add comprehensive module documentation and ADRs #1156
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
Improve codebase legibility for AI-assisted development without changing any logic. Add module-level documentation to all 43 modules explaining purpose, key types, and algorithms. Changes: - Add //! doc comments to all module files - Create README.md files in src/network/, src/auth/, src/middleware/, and src/client_query/ for quick orientation - Refactor main.rs into documented helper functions for initialization - Add context to NoIndexers error variant (now includes query selector) - Create Architecture Decision Records documenting: - ADR-001: Static allocations via Box::leak - ADR-002: Type-state pattern for indexer processing - ADR-003: PID controller for fee budget management - Fix rustdoc bare URL warnings
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Improve codebase legibility for AI-assisted development without changing any logic. Add module-level documentation to all 43 modules explaining purpose, key types, and algorithms.
Changes:
//!doc comments to all module filesREADME.mdfiles insrc/network/,src/auth/,src/middleware/, andsrc/client_query/for quick orientationmain.rsinto documented helper functions for initializationNoIndexerserror variant (now includes query selector)Box::leakSigned off by Joseph Livesey joseph@semiotic.ai