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

DOC: change rocketpy landing page to standard code docs. #584

Merged
merged 11 commits into from
Jun 7, 2024

Conversation

phmbressan
Copy link
Collaborator

@phmbressan phmbressan commented Apr 4, 2024

Pull request type

  • ReadMe, Docs and GitHub updates

Checklist

  • CHANGELOG.md has been updated (if relevant)

Current behavior

The current landing page of RocketPy documentation, despite being unique and self updating with the README, does not have the most friendly and straight to the point interface. The issues it entails are:

  • The page has a rather long scrollable that mirrors our README, not all users seek reading it every time;
  • In spite of having these sections in the top nav, newcomers might have trouble figuring out which page of the docs to go.

New behavior

This PR aims to change our landing page to a layout more familiar and similar to what is used by many other code based repositories. A summary of the changes:

  • The long README was removed from the landing page to favor more direct buttons;
  • Each page/"section" of RocketPy docs is clearly linked and their purpose explained;

Preview of the Changes

Click to see a preview of the new page:

image

Breaking change

  • Yes
  • No

@phmbressan phmbressan added the Docs Docs and examples related label Apr 4, 2024
@phmbressan phmbressan added this to the Release v1.X.0 milestone Apr 4, 2024
@phmbressan phmbressan self-assigned this Apr 4, 2024
@phmbressan phmbressan requested a review from a team as a code owner April 4, 2024 21:24
@phmbressan phmbressan marked this pull request as draft April 4, 2024 21:24
Copy link

codecov bot commented Apr 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.62%. Comparing base (73ec844) to head (1be4b29).
Report is 14 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #584      +/-   ##
===========================================
+ Coverage    73.56%   73.62%   +0.05%     
===========================================
  Files           70       70              
  Lines        10313    10313              
===========================================
+ Hits          7587     7593       +6     
+ Misses        2726     2720       -6     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@phmbressan phmbressan marked this pull request as ready for review May 30, 2024 21:13
Copy link
Member

@Gui-FernandesBR Gui-FernandesBR left a comment

Choose a reason for hiding this comment

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

LGTM

@phmbressan phmbressan merged commit 6deec5f into develop Jun 7, 2024
16 checks passed
@phmbressan phmbressan deleted the doc/landing-page branch June 7, 2024 12:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Docs and examples related
Projects
Status: Closed
Development

Successfully merging this pull request may close these issues.

2 participants