Merge pull request #484 from SuffolkLITLab/419_415_merge_reorganize_api_docs

Merge API docs and reorganize files into folders that match the sidebar navigation

Author: nonprofittechy

docs/alkiln/components/_scenario_folder_contents.js

@@ -2,7 +2,7 @@
 id: bootcamp
 title: Suffolk LIT Lab's Document Assembly Line Bootcamp
 sidebar_label: Bootcamp
-slug: /archive/bootcamp
+slug: bootcamp
 ---
 
 :::info
@@ -46,9 +46,9 @@ After signing up, you should have received invites to our docassemble server (ht
 
 Resources from the session:
 
-* [Running templates through the Weaver](weaver_overview.md)
-* [Labeling PDF variables](pdf_templates.md)
-* [Naming Variables Quick Reference](doc_vars_reference.md)
+* [Running templates through the Weaver](../authoring/weaver_overview.md)
+* [Labeling PDF variables](../authoring/pdf_templates.md)
+* [Naming Variables Quick Reference](../authoring/doc_vars_reference.md)
 * [The LIST taxonomy](https://taxonomy.legal/)
 
 Homework:
@@ -78,7 +78,7 @@ additional questions.
 
 <iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/VAzXYEacN78" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
 
-* [Using Github in Docassemble](github.md)
+* [Using Github in Docassemble](../authoring/github.md)
 * Customizing basic branding with the [ALThemeTemplate](https://github.com/SuffolkLITLab/docassemble-ALThemeTemplate) package.
     * Logo
     * Intro screen

docs/alkiln/components/_secure_env_vars.md

@@ -2,7 +2,7 @@
 id: customizing_interview
 title: Editing your interview
 sidebar_label: Editing your interview
-slug: /customizing_interview
+slug: customizing_interview
 ---
 
 ## Edit your completed draft interview in the Docassemble playground
@@ -34,7 +34,7 @@ quite right, perhaps something as simple as a typo.
 ## Work towards a readable, usable interview
 
 You should also take this chance to review our guidance about
-[writing good questions](/docs/question_style_overview.md). While you edit
+[writing good questions](../style_guide/question_style_overview.md). While you edit
 your interview, work steadily to make it better.
 
 ## Getting the draft into your playground
@@ -56,11 +56,11 @@ Before downloading the package, turn off that behavior:
 First, create a new "Project" in your playground. Using projects will
 help you keep your Docassemble code organized.
 
-![playground | projects ](./assets/playground_projects.png)
+![playground | projects ](../assets/playground_projects.png)
 
 Next, upload this file to the Docassemble playground's `Packages` folder.
 
-![Folders | Packages ](./assets/playground_packages_menu.png)
+![Folders | Packages ](../assets/playground_packages_menu.png)
 
 ## How to edit your interview
 
@@ -76,15 +76,15 @@ Scroll through and take a look at the code. You will see:
   that are asked on each screen
 
 You do not need to understand all of the code. Absorb what you can, and feel free
-to experiment. Save your code often, preferably to a [GitHub](/docs/github) repository.
+to experiment. Save your code often, preferably to a [GitHub](../authoring/github.md) repository.
 
 You will likely start by clicking the "Save and Run" button to try running your
 interview through to the end. Note any awkward wording or changes you want to make.
 
 Use the `id` that is on the top of each screen to find the screen that you want to change.
 Then, change the text that you want to change, or change the order of fields.
 
-![id: request a guardianship](./assets/playground_id.png)
+![id: request a guardianship](../assets/playground_id.png)
 
 Below we describe some of the most common starting customizations you will make,
 especially changes that interact with an Assembly Line convention.
@@ -436,7 +436,7 @@ content: |
 We usually don't recommend using the other options,
 which include help for the whole page (it comes too late) or `terms` (they get very cluttered very quickly).
 
-A more complete guide to [helping your user](/docs/coding_style/yaml_interface.md#adding-help-in-context).
+A more complete guide to [helping your user](../coding_style/yaml_interface.md#adding-help-in-context).
 
 ## Why is this question getting asked?!!!
 
@@ -754,4 +754,4 @@ with the blinking cursor.
 If you want to discard your changes and start over, upload the package .ZIP file
 to your playground again. This will wipe out all of your changes.
 
-Use [GitHub](/docs/github) regularly to let you restore your work from a point in time.
+Use [GitHub](../authoring/github.md) regularly to let you restore your work from a point in time.

docs/alkiln/components/_with_secrets.md

@@ -2,7 +2,7 @@
 id: document_variables_reference
 title: Field labels to use in template files
 sidebar_label: Field labels to use in template files
-slug: /label_variables
+slug: label_variables
 ---
 
 The Document Assembly Line framework can help you automate templates that use any
@@ -11,8 +11,8 @@ that we list below for full compatibility.
 
 ## Example documents
 
-- [A fully labeled PDF](./assets/generic_motion_family_law.pdf)
-- [The DOCX version of the same motion](./assets/generic_motion_family_law.docx)
+- [A fully labeled PDF](../assets/generic_motion_family_law.pdf)
+- [The DOCX version of the same motion](../assets/generic_motion_family_law.docx)
 
 :::info Use a custom AI assistant for labeling instead
 
@@ -48,12 +48,12 @@ rules below to add as many custom labels as you need.
 #### Labels should be valid Python variable names that start with a letter
 
 PDF and DOCX `labels` should also work as valid [Python variable
-names](/docs/coding_style_guide/python). The basic rule is that Python variable names
+names](../coding_style/python.md). The basic rule is that Python variable names
 need to start with a letter and can only contain letters, digits, and the `_`
 underscore character. Some variable names are
-[reserved](framework/reserved_keywords.md) and have a special meaning inside
+[reserved](../components/AssemblyLine/reserved_keywords.md) and have a special meaning inside
 AssemblyLine interviews. You should not use a variable name on the
-[reserved](framework/reserved_keywords.md) list. Doing so can lead to 
+[reserved](../components/AssemblyLine/reserved_keywords.md) list. Doing so can lead to 
 hard to track bugs.
 
 #### Variable names are case sensitive - make them all lowercase
@@ -395,4 +395,4 @@ your edited template directly to the Docassemble playground's templates folder.
 
 ## See also
 
-- [List of reserved variable names](framework/reserved_keywords.md)
+- [List of reserved variable names](../components/AssemblyLine/reserved_keywords.md)

docs/archive/bootcamp.md

@@ -2,7 +2,7 @@
 id: docx_templates
 title: Working with DOCX files
 sidebar_label: Working with DOCX files
-slug: /docx
+slug: docx
 ---
 
 :::tip
@@ -193,7 +193,7 @@ each condition.
 ### Use `output_checkbox()` for conditional checkbox fields that look like paper forms
 
 In some cases, you need to make your Word Document look like a document that was
-filled in by hand. [`output_checkbox()`](https://assemblyline.suffolklitlab.org/docs/framework/altoolbox#shorthand-function-to-display-a-checkbox-in-replace-of-a-truefalse-boolean-value-in-a-docx-template) can be used to add a checkbox in-line in your document.
+filled in by hand. [`output_checkbox()`](../components/ALToolbox/altoolbox_overview.md#shorthand-function-to-display-a-checkbox-in-replace-of-a-truefalse-boolean-value-in-a-docx-template) can be used to add a checkbox in-line in your document.
 
 These two expressions are equivalent, but the second version takes substantially less
 space in your template: