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 tips section on the home page #10541

Open
wants to merge 4 commits into
base: next
Choose a base branch
from
Open

Add a tips section on the home page #10541

wants to merge 4 commits into from

Conversation

djhi
Copy link
Collaborator

@djhi djhi commented Feb 21, 2025

Problem

We have many tips that we regularly post on different medias. It's a shame we don't use them on the documentation itself

Solution

How To Test

  • make doc
  • click the Documentation link in the app bar
  • press refresh and you should get a different tip each time
  • Use links and the browser back button to navigate. Ensure the tips is only ever displayed on the documentation page and that the right side TOC is never displayed on the documentation page.

Additional Checks

  • The PR targets master for a bugfix, or next for a feature
  • The documentation is up to date

Also, please make sure to read the contributing guidelines.

@djhi djhi added the RFR Ready For Review label Feb 21, 2025
@guilbill guilbill self-requested a review February 24, 2025 13:27
@guilbill guilbill changed the base branch from master to next February 24, 2025 13:31
} else {
// fetch the new content
fetch(window.location.pathname)
.then(res => res.text())
.then(replaceContent)
.then(() => {
toggleDockBlocks(false);
Copy link
Contributor

@guilbill guilbill Feb 24, 2025

Choose a reason for hiding this comment

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

I know it's not from your PR but this typo trigger me...

- toggleDockBlocks(false);
+ toggleDocBlocks(false);

Copy link
Contributor

@guilbill guilbill left a comment

Choose a reason for hiding this comment

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

Thanks for the fix on the navigation and the simplification with the modules 👍🏻
Regarding the tips section, I'm a bit annoyed by the flickering introduced with this part...
Screencast from 2025-02-24 14-51-12.webm
I don't know what is the best solution but I think we can do better, let's discuss that with the rest of the team to find some ideas.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
RFR Ready For Review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants