Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add mdbook site #176

Merged
merged 7 commits into from
Jun 1, 2020
Merged

Add mdbook site #176

merged 7 commits into from
Jun 1, 2020

Conversation

Luni-4
Copy link
Collaborator

@Luni-4 Luni-4 commented May 14, 2020

This PR closes the last item of #139. It addresses the following problems:

  • Explain the most common commands and provide some information about rust-code-analysis
  • Implement a shell script to automatically deploy the site on GitHub Pages
  • Create a temporary directory containing the documentation of rust-code-analysis (if the crate will be released on crates.io, that directory won't be no more necessary and subsequently removed)
  • Update README

You can find the final results here

Thanks in advance for your review! :)

@Luni-4 Luni-4 requested review from marco-c and calixteman May 14, 2020 16:29
@Luni-4
Copy link
Collaborator Author

Luni-4 commented May 18, 2020

Removed the great amount of files used as documentation

@codecov-commenter
Copy link

codecov-commenter commented May 19, 2020

Codecov Report

Merging #176 into master will increase coverage by 0.03%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #176      +/-   ##
==========================================
+ Coverage   15.84%   15.87%   +0.03%     
==========================================
  Files          44       44              
  Lines        5448     5448              
  Branches      597      597              
==========================================
+ Hits          863      865       +2     
+ Misses       4304     4301       -3     
- Partials      281      282       +1     
Impacted Files Coverage Δ
src/metrics/loc.rs 46.28% <0.00%> (+1.65%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1bac694...6975aff. Read the comment docs.

@calixteman calixteman merged commit c411a7a into mozilla:master Jun 1, 2020
@calixteman
Copy link
Collaborator

Thx for this work

@Luni-4 Luni-4 deleted the docs-site branch June 1, 2020 10:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants