-
-
Notifications
You must be signed in to change notification settings - Fork 423
[skip changelog] document the docs generation workflow #738
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
Conversation
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.
Unrelated to this PR, but I thought this paragraph should be upper in the page as it's more human-related than technical.
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.
Thanks for this @masci!
I only have some minor nitpicky suggestions for you.
Co-authored-by: per1234 <accounts@perglass.com>
* [skip changelog] document the docs generation workflow * clarify how humans should not push to gh-pages * Apply suggestions from code review Co-authored-by: per1234 <accounts@perglass.com> Co-authored-by: per1234 <accounts@perglass.com>
Please check if the PR fulfills these requirements
It adds better documentation around the process we use to generated the documentation website at https://arduino.github.io/arduino-cli/
Current documentation on the topic is incomplete and slightly incorrect/outdated.
Any aspect of the process of generating docs for different versions of the Arduino CLI has been detailed.
No changes to the CLI.
These docs are intended for CLI developers, not CLI users, so I've just expanded
CONTRIBUTING.mdbut this is completely arbitrary, happy to move them to a better location if needed.See how to contribute