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

docs: autogenerated page comment does not matching dirName in examples #8364

Merged
merged 1 commit into from
Nov 23, 2022
Merged

docs: autogenerated page comment does not matching dirName in examples #8364

merged 1 commit into from
Nov 23, 2022

Conversation

HumbleDeer
Copy link
Contributor

@HumbleDeer HumbleDeer commented Nov 22, 2022

The doc referred to the directory docs/tutorials/advanced, but the comment next to it (still) referred to docs/tutorial/hard. Additionally, one item (numbered folders) also referred to "Tutorial Hard", which has now been changed to "Tutorial Advanced".

Pre-flight checklist

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

Motivation

Test Plan

Page:
"Autogenerated"

Comments (under "Real World Example"):
image
image

Folder name (first block under Using Number Prefixes):
image

Test links

Deploy preview: https://deploy-preview-8364--docusaurus-2.netlify.app/docs/sidebar/autogenerated

The doc referred to the directory docs/tutorials/advanced, but the comment next to it (still) referred to docs/tutorial/hard.
Additionally, one item (numbered folders) also referred to "Tutorial Hard", which has now been changed to "Tutorial Advanced".
@HumbleDeer
Copy link
Contributor Author

I didn't manually ask for a code review from anyone 😅

@netlify
Copy link

netlify bot commented Nov 22, 2022

[V2]

Built without sensitive environment variables

Name Link
🔨 Latest commit 4d40892
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/637d4350c7e1b7000863e51c
😎 Deploy Preview https://deploy-preview-8364--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 settings.

@github-actions
Copy link

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟠 88 🟢 97 🟢 100 🟢 100 🟢 90 Report
/docs/installation 🟠 78 🟢 100 🟢 100 🟢 100 🟢 90 Report

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Nov 22, 2022
@slorber slorber added the pr: documentation This PR works on the website or other text documents in the repo. label Nov 23, 2022
@slorber
Copy link
Collaborator

slorber commented Nov 23, 2022

thanks, LGTM 👍

I didn't manually ask for a code review from anyone 😅

That's automated thanks to the codeowners file: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners

@slorber slorber changed the title docs: comment not matching dirName docs: autogenerated page comment does not matching dirName in examples Nov 23, 2022
@slorber slorber merged commit 4b11c57 into facebook:main Nov 23, 2022
@HumbleDeer HumbleDeer deleted the patch-1 branch November 24, 2022 03:10
This was referenced Oct 19, 2023
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: documentation This PR works on the website or other text documents in the repo.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants