Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

[skip changelog] Add CLI documentation #602

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

Merged
masci merged 15 commits into master from massi/docs
Mar 5, 2020
Merged

[skip changelog] Add CLI documentation #602

masci merged 15 commits into master from massi/docs
Mar 5, 2020

Conversation

Copy link
Contributor

@masci masci commented Mar 4, 2020
edited
Loading

First step towards building solid documentation around the project, this PR provides:

  • a command reference generator
  • a protobuf reference generator
  • a new folder docs to store documentation source files
  • a GitHub workflow to build and deploy a browsable documentation website
  • a new section of CONTRIBUTING.md explaining how to work with docs

Preview: https://arduino.github.io/arduino-cli/

zmoog reacted with heart emoji zmoog reacted with rocket emoji
@masci masci added the topic: documentation Related to documentation for the project label Mar 4, 2020
@masci masci requested a review from rsora March 4, 2020 16:22
Copy link
Contributor

@rsora rsora left a comment

Choose a reason for hiding this comment

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

Excellent!

@masci masci requested a review from rsora March 4, 2020 18:22
Copy link
Contributor

@rsora rsora left a comment

Choose a reason for hiding this comment

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

Excellent^2!

Copy link
Contributor

zmoog commented Mar 4, 2020

The preview website looks very very nice! ❤️

@masci masci merged commit 07e0520 into master Mar 5, 2020
@masci masci deleted the massi/docs branch March 5, 2020 08:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
1 more reviewer

@rsora rsora rsora approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
topic: documentation Related to documentation for the project
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

AltStyle によって変換されたページ (->オリジナル) /