-
-
Notifications
You must be signed in to change notification settings - Fork 8.8k
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
Conversation
Hi @arthurflageul! Thank you for your pull request and welcome to our community. Action RequiredIn 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. ProcessIn 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 If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks! |
✅ [V2]
To edit notification comments on pull requests, go to your Netlify site configuration. |
⚡️ Lighthouse report for the deploy preview of this PR
|
|
||
::: | ||
|
||
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: |
There was a problem hiding this comment.
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 :)
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
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 😅 |
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 |
Use a list of steps as the standard way to give instructions.
Improve SEO for the
configuring
section.Pre-flight checklist
Motivation
Test Plan
Test links
Deploy preview: https://deploy-preview-_____--docusaurus-2.netlify.app/
Related issues/PRs