-
Notifications
You must be signed in to change notification settings - Fork 7
docs: add App specification #67
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
docs/app-specification.md
Outdated
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 the name optional?
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.
I've removed the optional piece. Maybe we should just specify what's mandatory, implying that everything else is optional.
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.
Or, better, we should provide a JSON SCHEMA file (as we did for the Arduino CLI configuration) https://github.com/arduino/arduino-cli/blob/master/internal/cli/configuration/configuration.schema.json
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.
BTW, currently an empty app.yaml is valid and the ardiuno-app-cli is able to run it.
arduino@merola:~/ArduinoApps/my-app$ cat app.yaml
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.
I think we should discourage adding extra files in the root folder; maybe we could reserve an extras folder for user-specific data.
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.
What does it mean that it opens a "random" port? 🤔 What is this port used for?
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.
What's a "brick"? There is an entire session missing that explains what a "brick" is.
Uh oh!
There was an error while loading. Please reload this page.
Motivation
Change description
Additional Notes
Reviewer checklist
main.