arduino/library-registry
1
0
Fork 0
mirror of https://github.com/arduino/library-registry.git synced 2025-07-29 14:01:15 +03:00
Code Activity

Add table of contents to documentation

Browse Source 
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.
This commit is contained in:
per1234
2021-04-09 07:55:39 -07:00
parent 2d79e0e492
commit 4b40e08342
3 changed files with 100 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
FAQ.md
View File

@ -1,5 +1,32 @@
# Arduino Library Manager FAQ
## Table of Contents
<!-- toc -->
- [General](#general)
- [What is the Arduino Library Manager?](#what-is-the-arduino-library-manager)
- [How is the Library Manager index generated?](#how-is-the-library-manager-index-generated)
- [Submission](#submission)
- [How can I add my library to Library Manager?](#how-can-i-add-my-library-to-library-manager)
- [What are the requirements for a library to be added to Library Manager?](#what-are-the-requirements-for-a-library-to-be-added-to-library-manager)
- [Updates](#updates)
- [How can I publish a new release once my library is in the list?](#how-can-i-publish-a-new-release-once-my-library-is-in-the-list)
- [What are the requirements for publishing new releases of libraries already in the Library Manager list?](#what-are-the-requirements-for-publishing-new-releases-of-libraries-already-in-the-library-manager-list)
- [Why aren't releases of my library being picked up by Library Manager?](#why-arent-releases-of-my-library-being-picked-up-by-library-manager)
- [I did something wrong! How can I change or unpublish an already published library?](#i-did-something-wrong-how-can-i-change-or-unpublish-an-already-published-library)
- [How can I change my library's name?](#how-can-i-change-my-librarys-name)
- [Limitations](#limitations)
- [Is my Git repository OK?](#is-my-git-repository-ok)
- [Are Git submodules supported?](#are-git-submodules-supported)
- [Usage](#usage)
- [Can I add my own URL with my own library index?](#can-i-add-my-own-url-with-my-own-library-index)
- [When I install a library that I know depends on another library, will this other library be installed as well?](#when-i-install-a-library-that-i-know-depends-on-another-library-will-this-other-library-be-installed-as-well)
- [Can I install multiple versions of one library and use the proper one in my sketches?](#can-i-install-multiple-versions-of-one-library-and-use-the-proper-one-in-my-sketches)
- [How can I remove a library I installed via Library Manager?](#how-can-i-remove-a-library-i-installed-via-library-manager)
<!-- tocstop -->
## General
### What is the Arduino Library Manager?