docs: #377 update documentation #1116
Closed
Conversation
This file contains 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
- added readme documentation including building and run instructions - enhanced book documentation with detailed usage instructions
|
Thanks for the PR, @miguelcsx. It contains too many intertwined changes, could you submit them separately? |
Is it ok to commit different PRs or just one PR with different commits? |
|
Different PRs will be easier, so we can review them and merge them one by one. |
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
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.
rust-code-analysis-book:Enhanced the documentation to include detailed usage instructions for the book, ensuring that users can easily understand and utilize the new features and updates.
Benefits
rust-code-analysis-webandrust-code-analysis-cli.rust-code-analysis-book, improving overall user experience and accessibility.