-
-
Notifications
You must be signed in to change notification settings - Fork 314
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
chore: update the website docs #6565
Conversation
Performance Report✔️ no performance regression detected Full benchmark results
|
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## unstable #6565 +/- ##
=========================================
Coverage 61.46% 61.46%
=========================================
Files 556 556
Lines 58850 58850
Branches 1850 1850
=========================================
Hits 36171 36171
Misses 22638 22638
Partials 41 41 |
@@ -250,15 +250,9 @@ node scripts/download_dashboards.mjs | |||
|
|||
## Contributing to Documentation | |||
|
|||
When submitting PRs for documentation updates, build and run the documentation locally to ensure functionality before submission. For first time documentation contributors, install the python dependencies with `yarn docs:install`. Build the documentation locally with `yarn docs:build` and serve with `yarn docs:serve` | |||
When submitting PRs for documentation updates, build and run the documentation locally to ensure functionality before submission. First generate the CLI documentation with `yarn docs:build`. Then in the `docs` folder, build the documentation locally with `yarn install` and serve with `yarn start`. |
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.
Would it be possible to have all commands executed from root as we had previously?
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.
Sure! See #6571
🎉 This PR is included in v1.18.0 🎉 |
Motivation
Update the
CONTRIBUTING
guide to reflect recent migration to docusaurus.