search

mozilla / rust-code-analysis

Library to analyze and collect metrics on source code
https://mozilla.github.io/rust-code-analysis/
289 stars 49 forks source link

docs: #377 update documentation #1116

Closed miguelcsx closed 2 months ago

miguelcsx commented 2 months ago

Summary

This pull request introduces significant updates across multiple components of the project:

  1. 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.

  2. 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.

  3. 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

marco-c commented 2 months ago

Thanks for the PR, @miguelcsx. It contains too many intertwined changes, could you submit them separately?

miguelcsx commented 2 months ago

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?

marco-c commented 2 months ago

Different PRs will be easier, so we can review them and merge them one by one.