Integrate Library Manager FAQ into documentation #5
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
An FAQ hosted in the `arduino/Arduino` repository's wiki: https://github.com/arduino/Arduino/wiki/Library-Manager-FAQ has long served as the canonical guide for the traditional process for submitting libraries to the Library Manager index. Now that the submission process and support for the process has been moved from `arduino/Arduino` to this dedicated repository, it makes sense to also host the FAQ content here. This commit imports the exact unmodified content of the FAQ from https://github.com/arduino/Arduino/wiki/Library-Manager-FAQ/819425389e31540acee60eac9d1ade894659bf57
- Add page title - Bring into Prettier compliance - Minor manual formatting to improve readability
It is essential to clearly communicate the Library Manager requirements to the submitters. Previously, these requirements were scattered throughout the FAQ. Consolidating them into unified lists, then referencing that information from the other parts of the documentation makes it easier for the user to learn what are the requirements and easier for the documentation to be maintained.
Previously, library submitters were not exposed to the internal workings of the Library Manager index generation system, so they only needed to be concern with the public index file. Now the submitters will be interacting directly with the Library Manager submission list. This might lead to some confusion between that list and the Library Manager index, so it's important to be clear in the terminology used in the documentation.
This document is a collection of frequently asked questions, so it makes most sense for all entries to be phrased as questions.
A general pass of minor rewording.
per1234
added
topic: documentation
github-actions
bot
added
other
and removed
topic: documentation
|
Hi @per1234. Your pull request has been detected as something other than a Library Manager submission. A maintainer will need to review it before it can be merged. If you intended to submit a library, please check the instructions and update your pull request if necessary: |
silvanocerza
reviewed
Apr 9, 2021
silvanocerza
reviewed
Apr 9, 2021
silvanocerza
suggested changes
Apr 9, 2021
|
@per1234 scolded by your own actions. 🤣 |
At the time it was created, there was only one official Arduino development application: Arduino IDE. Since that time, Arduino Web Editor and Arduino CLI have been created, both of which implement Library Manager in their own manners.
Organize the questions accordging to type and importance.
It will be helpful to the reader to be able to get an overview of the documentation content and quickly navigate to the section of interest. The table of contents are automatically generated using the markdown-toc tool. Because it can be easy to forget to update the table of contents when the documentation content is changed, I have added a CI workflow to check for missed updates to readme ToC. On every push or pull request that affects the repository's documentation, it will check whether the table of contents matches the content.
silvanocerza
approved these changes
Apr 9, 2021
|
Hi @per1234. Your pull request has been detected as something other than a Library Manager submission. A maintainer will need to review it before it can be merged. If you intended to submit a library, please check the instructions and update your pull request if necessary: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
An FAQ hosted in the
arduino/Arduinorepository's wiki:https://github.com/arduino/Arduino/wiki/Library-Manager-FAQ
has long served as the canonical guide for the traditional process for submitting libraries to the Library Manager index.
Now that the submission process and support for the process has been moved from
arduino/Arduinoto this dedicatedrepository, it makes sense to also host the FAQ content here.
This required some updates to the content to account for the new advancements.
The content of the original wiki page will replaced with a link to the new location of the FAQ once we have made the transition to using the new submission system in this repository.