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

fix(docs): sidebar item label impact the pagination label of docs #10025

Merged
merged 3 commits into from
Apr 11, 2024

Conversation

Abdullah-03
Copy link
Contributor

@Abdullah-03 Abdullah-03 commented Apr 5, 2024

…file name as pagination label rather than the sidebar 'label' defined through item definition

Fixes #9781

Pre-flight checklist

  • I have read the Contributing Guidelines on pull requests.
  • If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
  • If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation

Bug fix

Test Plan

Ran local tests which passed and compiled the demo website to ensure that it runs and the bug is fixed.

Sample Doc file used without H1 or Title:

test

Properties set in sidebar:

{
      type: 'doc',
      label: 'Quick Start test',
      id: 'test',
}

Results (2nd screenshot is of page before test, so see the next button to view updated pagination label):
Screenshot 2024-04-05 234439
Screenshot 2024-04-05 234425

Test links

Deploy preview: https://deploy-preview-10025--docusaurus-2.netlify.app/

Related issues/PRs

#9781

…file name as pagination label rather than the sidebar 'label' defined through item definition

Fixes facebook#9781
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Apr 5, 2024
Copy link

netlify bot commented Apr 5, 2024

[V2]

Name Link
🔨 Latest commit dea3196
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/66180c393dbc9d0009209911
😎 Deploy Preview https://deploy-preview-10025--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

github-actions bot commented Apr 5, 2024

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟠 71 🟢 98 🟢 96 🟢 100 🟠 88 Report
/docs/installation 🟠 70 🟢 96 🟢 100 🟢 100 🟠 88 Report
/docs/category/getting-started 🟠 74 🟢 100 🟢 100 🟢 90 🟠 88 Report
/blog 🟠 70 🟢 100 🟢 100 🟢 90 🟠 88 Report
/blog/preparing-your-site-for-docusaurus-v3 🟠 63 🟢 96 🟢 100 🟢 100 🟠 88 Report
/blog/tags/release 🟠 70 🟢 100 🟢 100 🟠 80 🟠 88 Report
/blog/tags 🟠 75 🟢 100 🟢 100 🟢 90 🟠 88 Report

@slorber slorber changed the title Fix: set pagination label of doc using sidebar label through item definition fix(docs): sidebar item label impact the pagination label of docs Apr 11, 2024
Copy link
Collaborator

@slorber slorber left a comment

Choose a reason for hiding this comment

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

LGTM thanks 👍

@slorber slorber added the pr: bug fix This PR fixes a bug in a past release. label Apr 11, 2024
@slorber slorber merged commit e4ecffe into facebook:main Apr 11, 2024
31 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: bug fix This PR fixes a bug in a past release.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Generated Sidebar Pagination will not use doc Label but the File Name
3 participants