Skip to content

docs: refactor readme + guidelines #58

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
Open
wants to merge 30 commits into
base: main
Choose a base branch
from
Open

docs: refactor readme + guidelines #58

wants to merge 30 commits into from
+748 −65

Conversation

@dido18
Copy link
Contributor

@dido18 dido18 commented Nov 10, 2025 •
edited
Loading

Motivation

Going open source, we need a better issue-reporting mechanism and better documentation.

Change description

  • Edit the README with more concise information
  • Created a docs folder with
    • Contributing.md guide
    • contribute-guide with the markdown guide
    • user-documentation.md with an initial documentation of the arduino-app-cli
  • Creates a ISSUE_TEMPLATE folder with two types of issues "Bug report" or "Feature request"
  • Renamed arduino-app-cli:build:local: into buld and arduino-app-cli:start into start

Additional Notes

Taken from https://github.com/arduino/tooling-project-assets/
beta-testing has not been added

Reviewer checklist

  • PR addresses a single concern.
  • PR title and description are properly filled.
  • Changes will be merged in main.
  • Changes are covered by tests.
  • Logging is meaningful in case of troubleshooting.

alessio-perugini
alessio-perugini reviewed Nov 10, 2025
View reviewed changes
@per1234 per1234 added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 10, 2025
per1234
per1234 requested changes Nov 10, 2025
View reviewed changes
dido18 and others added 18 commits November 11, 2025 09:33
@dido18 @per1234
Update docs/contributor-guide/development.md
f4117d8 
Co-authored-by: Per Tillisch <[email protected]>
@dido18 @per1234
Update docs/contributor-guide/development.md
3a65f23 
Co-authored-by: Per Tillisch <[email protected]>
@dido18 @per1234
Update docs/contributor-guide/development.md
86c2ba0 
Co-authored-by: Per Tillisch <[email protected]>
@dido18 @per1234
Update docs/contributor-guide/development.md
3ec35e9 
Co-authored-by: Per Tillisch <[email protected]>
@dido18 @per1234
Update docs/contributor-guide/issues.md
608e486 
Co-authored-by: Per Tillisch <[email protected]>
@dido18 @per1234
Update docs/contributor-guide/issues.md
f36b0b6 
Co-authored-by: Per Tillisch <[email protected]>
@dido18 @per1234
Update docs/user-documentation.md
5e7502a 
Co-authored-by: Per Tillisch <[email protected]>
@dido18 @per1234
Update README.md
2894d79 
Co-authored-by: Per Tillisch <[email protected]>
@dido18 @per1234
Update README.md
a7c6c8f 
Co-authored-by: Per Tillisch <[email protected]>
@dido18 @per1234
Update README.md
bc7ef20 
Co-authored-by: Per Tillisch <[email protected]>
@dido18 @per1234
Update README.md
506dc89 
Co-authored-by: Per Tillisch <[email protected]>
@dido18
docs: clarify terminology in Docker images registry section of user d…
506c000 
…ocumentation
@dido18
docs: simplify description of arduino-app-cli in README.md
2d4f461
@dido18
docs: update contributor guide for clarity and accuracy
901f8de
@dido18
docs: update development guide and issue report instructions for clarity
4b5e754
@dido18
docs: restructure environment variables section for clarity and organ…
511aba4 
…ization
@dido18
docs: improve clarity and consistency in user documentation
e2c472a
@dido18
docs: add bug report and feature request issue templates for better u…
1643009 
…ser feedback
@dido18 dido18 changed the title docs: Add readme with CONTRIBUTING.md guidelines docs: refactor readme + guidelines Nov 11, 2025
@dido18 dido18 marked this pull request as ready for review November 11, 2025 14:05
@dido18 dido18 requested a review from a team November 11, 2025 14:21
dido18 and others added 4 commits November 11, 2025 17:01
@dido18
chore: update cli messages (#61)
b496ffa
@mirkoCrobu @dido18
Add Serial Number to Avahi Service for Board Deduplication (#48)
d16133c 
* set serial number for network discovery at post install time

* adds space in a comment

* set script running before Avahi service

* code review fix

* code review fix

* code review fix
@martacarbone @lucarin91 @dido18
Improve the arduino-app-cli version command by adding the "server ver…
e7ac2da 
…sion" #31 (#49)

* Add the server version to arduino-app-cli version.

* Add copyright header.

---------

Co-authored-by: Luca Rinaldi <[email protected]>
@dido18
docs: clarify description of temporary files in user documentation
1de2d4c
lucarin91
lucarin91 requested changes Nov 11, 2025
View reviewed changes
Copy link
Contributor

@lucarin91 lucarin91 left a comment

Choose a reason for hiding this comment

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

@dido18 can you rebase with the latest main?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lucarin91 lucarin91 lucarin91 requested changes

@per1234 per1234 per1234 requested changes

+1 more reviewer

@alessio-perugini alessio-perugini alessio-perugini left review comments

Reviewers whose approvals may not affect merge requirements

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@dido18 @lucarin91 @alessio-perugini @per1234 @mirkoCrobu @martacarbone