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 #5563

Merged

Conversation

trbromley
Copy link
Contributor

@trbromley trbromley commented Apr 23, 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 [sc-66837]

Benefits:

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

NB: Make many linux deprecation very loud and clear

@trbromley trbromley added this to the v0.36 milestone Apr 23, 2024
Copy link

codecov bot commented Apr 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.69%. Comparing base (9151477) to head (faceefa).
Report is 16 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5563      +/-   ##
==========================================
- Coverage   99.69%   99.69%   -0.01%     
==========================================
  Files         410      412       +2     
  Lines       38278    38273       -5     
==========================================
- Hits        38161    38155       -6     
- Misses        117      118       +1     

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

Copy link
Contributor

@isaacdevlugt isaacdevlugt left a comment

Choose a reason for hiding this comment

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

Nice! Seems pretty logical to me to do this.
Screenshot 2024-04-23 at 4 45 38 PM

Copy link
Contributor

@Qottmann Qottmann left a comment

Choose a reason for hiding this comment

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

Is it intentional the resturns.rst page is deleted or did you forget to git add it?

Otherwise looks good to me 👍

@isaacdevlugt
Copy link
Contributor

Is it intentional the resturns.rst page is deleted or did you forget to git add it?

Otherwise looks good to me 👍

@Qottmann this was intentional since it's been a good amount of time since that feature was released :)

@trbromley trbromley added the merge-ready ✔️ All tests pass and the PR is ready to be merged. label Apr 26, 2024
Qottmann and others added 2 commits April 26, 2024 15:43
…5569)

Add link to Quick Start guide in Deprecation Warning Messages and upon
disabling/re-enabling new opmath


[sc-61666]
Builds on #5563 that
restructures the help/news page

---------

Co-authored-by: Thomas R. Bromley <49409390+trbromley@users.noreply.github.com>
@astralcai astralcai enabled auto-merge (squash) April 26, 2024 20:30
@astralcai astralcai disabled auto-merge April 27, 2024 00:29
@astralcai astralcai enabled auto-merge (squash) April 27, 2024 00:29
@astralcai astralcai merged commit a98998e into master Apr 27, 2024
37 checks passed
@astralcai astralcai deleted the sc-61667-the-quickstart-is-updated-to-its-own-section_v2 branch April 27, 2024 00:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge-ready ✔️ All tests pass and the PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants