Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

docs(math): use list of steps for clearer guidance #9659

Merged
merged 4 commits into from
Dec 22, 2023

Conversation

ArthurFlag
Copy link
Contributor

@ArthurFlag ArthurFlag commented Dec 21, 2023

Use a list of steps as the standard way to give instructions.
Improve SEO for the configuring section.

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

Test Plan

Test links

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

Related issues/PRs

@ArthurFlag ArthurFlag requested a review from slorber as a code owner December 21, 2023 17:39
@facebook-github-bot
Copy link
Contributor

Hi @arthurflageul!

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!

@ArthurFlag ArthurFlag changed the title Use list of steps docs(math): use list of steps for clearer guidance Dec 21, 2023
Copy link

netlify bot commented Dec 21, 2023

[V2]

Name Link
🔨 Latest commit 2dbf901
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/65857827978df70008717b8d
😎 Deploy Preview https://deploy-preview-9659--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 Dec 21, 2023

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟠 68 🟢 98 🟢 100 🟢 100 🟠 89 Report
/docs/installation 🟠 85 🟢 98 🟢 100 🟢 100 🟠 89 Report
/docs/category/getting-started 🟠 76 🟢 100 🟢 100 🟢 90 🟠 89 Report
/blog 🟠 71 🟢 100 🟢 100 🟢 90 🟠 89 Report
/blog/preparing-your-site-for-docusaurus-v3 🟠 63 🟢 97 🟢 100 🟢 100 🟠 89 Report
/blog/tags/release 🟠 70 🟢 100 🟢 100 🟠 80 🟠 89 Report
/blog/tags 🟠 77 🟢 100 🟢 100 🟢 90 🟠 89 Report

@slorber
Copy link
Collaborator

slorber commented Dec 21, 2023

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Dec 21, 2023

:::

1. These 2 plugins are [**only available as ES Modules**](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c). We recommended to use an [**ES Modules**](https://flaviocopes.com/es-modules/) config file:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is this numbering enforced by any linting we have? If Prettier leaves them alone, I would suggest using 2.. We don't use 1. everywhere because that looks awkward :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fair enough, but I would highly consider having steps in task-style documentation sections. This is standard practice (see github, microsoft, and anyone else), and considering how heavy the docusuaurus docs are on contributions, I would expect ppl to potentially add steps in the middle of certain tasks to provide finer guidance from time to time, and if you have deal with numbering by hand, that's not fun.

Especially in the docs as code approach, it's so easy to build the output that the source shouldn't matter for readability all that much, but convenience should rule.

Happy to update the numbering if you think it's the best way to go.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yes, please update the numbers. Even if someone adds a number in between, it's obvious enough if the numbers don't match, and we would just update all following numbers.

@slorber
Copy link
Collaborator

slorber commented Dec 22, 2023

I'm not against this change but we have to make it pass linting / Prettier

And it doesn't seem to like it so far and seems hard to fix 😅

@slorber
Copy link
Collaborator

slorber commented Dec 22, 2023

source does not look super good but at least prettier and rendering are ok now 🤪

If someone want to reformat content why not but it's good enough to merge for now, thanks

@slorber slorber added the pr: documentation This PR works on the website or other text documents in the repo. label Dec 22, 2023
@slorber slorber merged commit d9d700c into facebook:main Dec 22, 2023
8 checks passed
@ArthurFlag ArthurFlag deleted the touch-up-math-docs branch August 22, 2024 13:49
# for free to join this conversation on GitHub. Already have an account? # 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.

4 participants