📝 [docs + vanilla] Update documentation

gelatolabs · Feb 14, 2021 · 804e238 · 804e238
1 parent 6296528
commit 804e238
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 4 deletions.
diff --git a/docs/98-stop-errors.md b/docs/98-stop-errors.md
@@ -0,0 +1,30 @@
+# Common Stop Errors
+
+If Candella encounters an issue that prompts restarting the game (or forcefully quitting it), a Stop error will be displayed on screen. These Stop error screens will display a code that can be used to identify the problem and look for possible solutions.
+
+## `REQUISITE_FRAMEWORK_MISSING`
+
+An app, core service, or framework is requiring a framework that doesn't exist on the system, or it cannot detect the framework it's looking for.
+
+### Common factors that produce this error
+
+- An app, core service, or framework has a misspelling in the framework name in the `requisites` field of the project's manifest.
+- The framework the app, core service, or framework is looking for isn't installed in the distribution of Candella.
+
+### Possible solutions
+
+- Check the `requisites` field in the manifest.json file of the project.
+- Check that the framework exists in the default framework directory (typically `System/Frameworks/`).
+- Reinstall the distribution.
+
+## `MISSING_OOBE_SERVICE`
+
+A core service that provides an out-of-box experience or setup assistant could not be found. This usually occurs when the Roland Boot Manager attempts to run a setup assistant and cannot detect one.
+
+### Common factors that produce this error
+
+- Either the AliceOS Setup Assistant or Thorax core service is missing.
+
+### Possible solutions
+
+- Reinstall the distribution.
diff --git a/docs/index.md b/docs/index.md
@@ -1,7 +1,3 @@
-# Candella
-
-Candella is a fork of the [AliceOS framework][aliceos], a Ren'Py framework that provides an operating environment to visual novels. This operating environment includes utilities, classes, and other code that lets developers and players write and use apps designed for the system.
-
 !!! warning "Prerelease Notice"
     Candella is in a pre-release state and my change over time. This documentation tries to reflect the most current pre-release version of Candella.
 

diff --git a/vanilla/head.html b/vanilla/head.html
@@ -3,6 +3,7 @@
 <head>
     <title>{% if page.title %}{{ page.title }} - {% endif %}{{ config.site_name }}</title>
     <link href="/css/vanilla.min.css" rel="stylesheet" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
     {%- if config.theme.highlightjs %}
     <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>

diff --git a/vanilla/js/vanilla.js b/vanilla/js/vanilla.js
@@ -1,3 +1,12 @@
+function getAllExternalLinks() {
+    let main = document.getElementById("main-content");
+    for (const link of main.getElementsByTagName("a")) {
+        if (link.href.search(window.location.hostname) === -1) {
+            link.classList.add("p-link--external")
+        }
+    }
+}
+
 function addTitleSeparator() {
     let main = document.getElementById("main-content");
     let firstTitle = main.getElementsByTagName("h1");
@@ -36,5 +45,6 @@ function convertAdmonitions() {
     }
 }
 
+getAllExternalLinks();
 addTitleSeparator();
 convertAdmonitions();
diff --git a/vanilla/sidebar.html b/vanilla/sidebar.html
@@ -16,10 +16,12 @@
 
         {% for nav_item in nav %}
         <ul class="p-side-navigation__list">
+            {% if nav_item.title %}
             <li class="p-side-navigation__item--title">
                 <a class="p-side-navigation__link" href="{{ nav_item.url|url }}" {% if nav_item.active
                     %}aria-current="page" {% endif %}>{{ nav_item.title }}</a>
             </li>
+            {% endif %}
 
             {% for toc_item in nav_item.toc %}
             {% for toc_child in toc_item.children %}