1
0
mirror of https://github.com/arduino/library-registry.git synced 2025-11-08 09:22:24 +03:00
Commit Graph

6 Commits

Author SHA1 Message Date
per1234
d8f30c0316 Document policy re: who can add libraries to Library Manager
The official policy is that anyone is allowed to submit any library to Library Manager, regardless of whether they have
any involvement with the development and maintenance of the library.

As someone very much involved in the submission process, I have always wondered this myself. So it is very important to
clearly document this.

Some of the wording of the existing documentation implied that only the owner of the library could submit it, so this
text has been adjusted as well.
2021-04-14 00:33:34 -07:00
per1234
4b40e08342 Add table of contents to documentation
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.
2021-04-09 08:42:55 -07:00
per1234
beb45f13df Consolidate list of requirements in FAQ
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.
2021-04-09 08:01:37 -07:00
per1234
9e9cabee69 Import Library Manager FAQ
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
819425389e
2021-04-09 01:41:39 -07:00
per1234
4f2d7a7e2a Update documentation to reflect repository name change
The repository was renamed from `arduino/library-manager-list` to `arduino/library-registry`.
2021-04-08 21:09:01 -07:00
per1234
050ac29d24 Automate the Library Manager submission process
Submissions of libraries to the Arduino Library Manager index can be done by submitting a pull request adding repositor
URLs to the list. The submissions are checked for compliance wih the requirements for addition to the index and as soon
as they are passing the pull request is merged and the entries are pushed to the index source file.
2021-01-19 00:05:38 -08:00