Skip to content

[skip changelog] Add Arduino CLI integration options documentation #733

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jun 10, 2020
Merged

[skip changelog] Add Arduino CLI integration options documentation #733

merged 1 commit into from
Jun 10, 2020

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented May 31, 2020

Please check if the PR fulfills these requirements

  • The PR has no duplicates (please search among the Pull Requests before creating one)
  • The PR follows our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • What kind of change does this PR introduce?

Provide an overview of the integration options the Arduino IDE provides:

  • command line
  • gRPC
  • Go library
  • What is the current behavior?

Although there is detailed reference documentation for the command line and gRPC interfaces of Arduino CLI, there is no general overview to introduce people to the different ways this software may be used.

  • What is the new behavior?

The documentation contains a nice overview of the three interfaces provided by Arduino CLI.

  • Does this PR introduce a breaking change?

No.

  • Other information:

All credit for this content goes to @masci. I have merely converted it to Markdown and added some links (possibly too many, let me know).

Built docs: https://per1234.github.io/arduino-cli/latest/integration-options/

@per1234
[skip changelog] Add Arduino CLI integration options documentation
8bec165 
Arduino CLI provides three interfaces for integration:
- command line
- gRPC
- Go library

This is an article written by Massimiliano Pippi, which I have merely converted to Markdown and added some links to.
@per1234 per1234 added component/CLI topic: documentation Related to documentation for the project labels May 31, 2020
rsora
rsora approved these changes Jun 10, 2020
View reviewed changes
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.

👍

@rsora rsora merged commit 554b822 into arduino:master Jun 10, 2020
@per1234 per1234 deleted the three-pillars branch June 11, 2020 10:21
umbynos pushed a commit that referenced this pull request Jun 17, 2020
@per1234 @umbynos
[skip changelog] Add Arduino CLI integration options documentation (#733
8a5dbd0 
)

Arduino CLI provides three interfaces for integration:
- command line
- gRPC
- Go library

This is an article written by Massimiliano Pippi, which I have merely converted to Markdown and added some links to.
@per1234 per1234 self-assigned this Nov 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rsora rsora rsora approved these changes

Assignees

@per1234 per1234

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.
2 participants
@per1234 @rsora