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

docs: refresh documentation structure #552

Merged
merged 1 commit into from
Oct 12, 2020
Merged

docs: refresh documentation structure #552

merged 1 commit into from
Oct 12, 2020

Conversation

bobheadxi
Copy link
Member

@bobheadxi bobheadxi commented Oct 12, 2020

Big refresh of the Rocket 2 docsite structure:

  • more readme based on https://github.com/ubclaunchpad/inertia
  • consolidate some pages (moved Scheduler to development tutorials), reorganize order
  • simplify contributions
  • document columns used in the Rocket 2 github project

Ticket(s)

closes #350

Details

pipenv shell
make html && serve ./_build/html   

@bobheadxi bobheadxi requested a review from chuck-sys October 12, 2020 02:30
@bobheadxi bobheadxi requested review from a team as code owners October 12, 2020 02:30
@codecov
Copy link

codecov bot commented Oct 12, 2020

Codecov Report

Merging #552 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #552   +/-   ##
=======================================
  Coverage   93.81%   93.81%           
=======================================
  Files          47       47           
  Lines        2669     2669           
  Branches      361      361           
=======================================
  Hits         2504     2504           
  Misses        108      108           
  Partials       57       57           

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 2c3e6af...c78129f. Read the comment docs.

@bobheadxi bobheadxi force-pushed the rocket-refreshed branch 2 times, most recently from 80b6a2e to 738ace7 Compare October 12, 2020 02:39
@chuck-sys
Copy link
Collaborator

@bobheadxi
Copy link
Member Author

oh wow TIL readthedocs does branch previews!

Copy link
Collaborator

@chuck-sys chuck-sys left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm looking through the docs (the ones that were touched the least) and a lot of things are out of date, one of which being one of the Development tutorials.

There will be a time for fixing these and updating them. But this PR is not one of them.

LGTM

@bobheadxi bobheadxi merged commit 8f0bda7 into master Oct 12, 2020
@bobheadxi bobheadxi deleted the rocket-refreshed branch October 12, 2020 03:00
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.

Make a nice docs landing page
2 participants