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 a Release News section to the table of contents #5548

Closed

Conversation

trbromley
Copy link
Contributor

@trbromley trbromley commented Apr 19, 2024

Context:

#5483 adds a new quickstart guiding users through the changes to op arithmetic. However, there are too many quickstarts in the table of contents.

Description of the Change:

  • A new "Release news" section has been added to the table of contents, including the release notes, deprecations, and the op arithmetic update page.
  • The new return types troubleshooting page has been removed.

Benefits:

A clearer distinction between quickstarts (guiding users to quickly get started with the library) and news/time-based pages (now called "Release news").

Closed in favour of #5563.

@trbromley trbromley changed the base branch from master to newopmathintro April 19, 2024 20:18
Comment on lines +176 to +177
development/release_notes.md
development/deprecations
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I decided not to move the location of these two pages in the codebase, because this location also determines the URL and we have shared these pages extensively over the year.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This page has been around for ~12 months and the toggle was even removed in 0.33. Now seems a good time to remove this page.

Copy link

codecov bot commented Apr 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

❗ No coverage uploaded for pull request base (newopmathintro@46f059f). Click here to learn what that means.

Additional details and impacted files
@@                Coverage Diff                @@
##             newopmathintro    #5548   +/-   ##
=================================================
  Coverage                  ?   99.66%           
=================================================
  Files                     ?      406           
  Lines                     ?    37635           
  Branches                  ?        0           
=================================================
  Hits                      ?    37510           
  Misses                    ?      125           
  Partials                  ?        0           

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

Base automatically changed from newopmathintro to master April 23, 2024 14:53
@trbromley
Copy link
Contributor Author

Closed in favour of #5563.

@trbromley trbromley closed this Apr 23, 2024
@trbromley trbromley deleted the sc-61667-the-quickstart-is-updated-to-its-own-section branch April 23, 2024 18:26
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.

2 participants