docs: add rustdoc comments and update README architecture section#142
Merged
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
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.
This pull request introduces extensive inline documentation throughout the codebase, primarily by adding Rust doc comments to public functions and data structures. These comments clarify the purpose and usage of key modules related to SSH and SFTP functionality. Additionally, the
README.mdhas been updated to better describe the architecture and roadmap of the project.Documentation Improvements:
src/config_observer.rs,src/sftp_engine.rs, andsrc/ssh_engine.rs, making the codebase significantly more understandable for future contributors. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18] [19] [20] [21] [22] [23]Project Documentation:
README.mdwith a new architecture section, clarified the roadmap, and improved descriptions of features and planned work.These changes greatly improve the maintainability and approachability of the code by making both the implementation and project goals more transparent.