Startup FAQ

documentation/configuration/start.md

@@ -9,3 +9,8 @@ _This page assume that you have already completed the [installation](/docs/insta
 :::
 
 Before you start with the configuration, you will need to go to GitHub to get a [Personal Access Token.](/docs/configuration/pat)
+
+
+:::tip
+Read [this FAQ](/docs/faq/initial_startup) about the first startup of HACS.
+:::

documentation/faq/initial_startup.md

@@ -0,0 +1,17 @@
+---
+id: initial_startup
+title: "Initial startup"
+description: "Initial startup"
+---
+HACS does not ship with any knowledge about the repositories it is supposed to show.
+
+Since there is no central "HACS server", every installation of HACS fetches this information from GitHub, it has to get the information about all [default repositories](/docs/default_repositories)
+
+To get the information that is needed to show a representation of the repository in HACS, HACS uses the [GitHub API](https://docs.github.com/en/rest), this API is [ratelimited](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting) and when you hit that ratelimit HACS will pause any communitation to the GitHub API untill the ratelimit reset (can take up to one hour).
+
+:::info
+For new installation of HACS with the current amout of default repositories you will hit that ratelimit on the initial startup after installing HACS.
+Because of this HACS will be in a "Starting up" state untill it's done fetching the information for all [default repositories](/docs/default_repositories)
+
+Which in return will cause the initial startup of HACS to take over 1 hour to finish.
+:::

sidebars.js

@@ -67,6 +67,7 @@ module.exports = {
  "faq/addons",
  "faq/installation",
  "faq/upgrade",
+ "faq/initial_startup",
  "faq/status_not_loaded",
  "faq/custom_repositories",
  "faq/limitations",