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): the _category_.json description attribute should display on generated index pages #10324

Conversation

bharateshwq
Copy link
Contributor

@bharateshwq bharateshwq commented Jul 21, 2024

Motivation

This pull request adds support docs _category_.json description attribute.

This description attribute will display on the autogenerated index page.

Fix #7818

Test Plan

https://deploy-preview-10324--docusaurus-2.netlify.app/tests/docs/category/tests

Thi works for category of autogenerated sidebar slice, using _category_.json description:

CleanShot 2024-08-09 at 11 17 17@2x

This also works for manually defined sidebar category with a description

CleanShot 2024-08-09 at 11 17 00@2x

@facebook-github-bot
Copy link
Contributor

Hi @bharateshwq!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

Copy link

github-actions bot commented Jul 21, 2024

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO Report
/ 🟠 50 🟢 98 🟢 96 🟢 100 Report
/docs/installation 🟠 53 🟢 97 🟢 100 🟢 100 Report
/docs/category/getting-started 🟠 74 🟢 100 🟢 100 🟠 86 Report
/blog 🟠 67 🟢 96 🟢 100 🟠 86 Report
/blog/preparing-your-site-for-docusaurus-v3 🔴 48 🟢 92 🟢 100 🟢 100 Report
/blog/tags/release 🟠 69 🟢 96 🟢 100 🟠 86 Report
/blog/tags 🟠 75 🟢 100 🟢 100 🟠 86 Report

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Jul 21, 2024
Copy link

netlify bot commented Jul 21, 2024

[V2]

Name Link
🔨 Latest commit 95d31e0
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/66b5dfe79d814a00089e50da
😎 Deploy Preview https://deploy-preview-10324--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.

@slorber slorber changed the title fix: add description to subcategories throguh _category_.json file fix(docs): the _category_.json description attribute should display on generated index pages Aug 9, 2024
@slorber slorber added the pr: bug fix This PR fixes a bug in a past release. label Aug 9, 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

Did some cleanup but it's working 👍

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.

Category auto-generated index page should support custom category/link descriptions
3 participants