docs: #377 create documentation #1117
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
Contributor
Author
|
@marco-c This first PR includes readmes for developers, about the flags that have been created, the structure of the project, and how to build and run, let me know any feedback, thanks. |
marco-c
reviewed
Sep 23, 2024
marco-c
reviewed
Sep 23, 2024
marco-c
reviewed
Sep 23, 2024
marco-c
reviewed
Sep 23, 2024
marco-c
reviewed
Sep 23, 2024
marco-c
reviewed
Sep 23, 2024
marco-c
reviewed
Sep 23, 2024
marco-c
reviewed
Sep 23, 2024
marco-c
reviewed
Sep 23, 2024
marco-c
reviewed
Sep 23, 2024
Contributor
Author
|
@marco-c I made the suggested changes, I look forward to any comments. |
Luni-4
approved these changes
Apr 24, 2025
- added documentation per package module - included information about the code, how to build and run it - give information about the flags that can be used
- reworded the first sentences to make it clearer - removed project structure as requested - removed sentence about rust installation - replaced `cargo run` with respective command
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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
This pull request introduces significant updates across multiple components of the project:
rust-code-analysis-web:Added a README.md with comprehensive documentation on how to build and run the web server. This includes instructions for setting up the project, dependencies, and starting the server.
rust-code-analysis-cli:Updated the project with a new README.md file providing detailed instructions for building and running the command-line interface (CLI). The documentation includes usage examples and options available in the CLI.
Benefits
rust-code-analysis-webandrust-code-analysis-cli.