-
-
Notifications
You must be signed in to change notification settings - Fork 386
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
[skip changelog] Migrate relevant documentation pages from arduino/Arduino wiki #616
Conversation
This is required for table of contents generation.
The backslash at end of line to cause line break is not supported by the documentation build system.
The documentation build system requires a blank line before the start of a list
* rev.2.1 will be implemented starting from version 1.6.10 | ||
* rev.2.2 will be implemented starting from version 1.8.10 | ||
|
||
This new library format is intended to be used in tandem with the Arduino IDE"s **Library Manager**, available since version 1.6.2. The Library Manager allows users to automatically download and install libraries needed in their projects, with an easy to use graphic interface. It doesn't yet take care of dependencies between libraries. |
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.
This new library format is intended to be used in tandem with the Arduino IDE"s **Library Manager**, available since version 1.6.2. The Library Manager allows users to automatically download and install libraries needed in their projects, with an easy to use graphic interface. It doesn't yet take care of dependencies between libraries. | |
This new library format is intended to be used in tandem with the Arduino IDE's **Library Manager**, available since version 1.6.2. The Library Manager allows users to automatically download and install libraries needed in their projects, with an easy to use graphic interface. It doesn't yet take care of dependencies between libraries. |
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 also noticed this, as well as some other issues, but I thought it would be best for this PR to be as much a straight across migration of the content as possible, since I know all the commits will be squashed. This typo exists in the original content, it's not something I introduced during the migration.
I had planned to submit a follow up PR to fix the issues I noticed while I was doing the migration.
That said, if you want me to fix this in this PR, I'm happy to do so. I'm glad I'm not the only one who notices and cares about these sorts of details.
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.
We can merge and fix it right after, I have no objections, so let's wait for @cmaglie review on the topic level then.
|
||
## Old library format (pre-1.5) | ||
|
||
In order to support old libraries (from Arduino 1.0.x), Arduino 1.5.x+ will also compile libraries missing a library.properties metadata file. As a result, these libraries should behave as they did in Arduino 1.0.x, although they will be available for all boards, including non-AVR ones (which wouldn’t have been present in 1.0.x). |
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.
In order to support old libraries (from Arduino 1.0.x), Arduino 1.5.x+ will also compile libraries missing a library.properties metadata file. As a result, these libraries should behave as they did in Arduino 1.0.x, although they will be available for all boards, including non-AVR ones (which wouldn’t have been present in 1.0.x). | |
In order to support old libraries (from Arduino IDE 1.0.x), Arduino IDE 1.5.x+ will also compile libraries missing a library.properties metadata file. As a result, these libraries should behave as they did in Arduino IDE 1.0.x, although they will be available for all boards, including non-AVR ones (which wouldn’t have been present in 1.0.x). |
Maybe it would be good to put up a notice on these wikipages that they are being migrated, to prevent people from editing them on the wiki and getting divergent versions? |
@matthijskooijman yes, our plan is to update also the wiki referencing this new docs pages, once we merge the PR 👍 |
My suggestion was to update it now, to prevent people from editing the page from now until the PR is merged. |
@per1234 can you help with this? @matthijskooijman is right, we should avoid wiki unattended updates |
I have done as requested. |
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.
After rereading all the docs, I think we should refine some pieces that are a bit ambiguous (in particular the when we try to describe in detail the internals of the builder, that part requires some love :-) ).
But overall I like it.
These are all the pages from the arduino/Arduino wiki that are relevant to arduino-cli:
The changes I made to that content during the migration:
After some deliberation, I put the pages at the top level of the documentation structure:
I'm open to putting them in a subcategory ("More"?) if you prefer.
Built docs: https://per1234.github.io/arduino-cli/