add headers to index files and text stating stub

docs/communications-tools/index.md

@@ -1 +1,5 @@
+# Tools for communication
+
+_This content is a stub._
+
 This section will contain information about communications, including using Slack, GitHub Issues, and GitHub Discussions.

docs/contributing-to-analyses/index.md

@@ -1,2 +1,6 @@
+# Contributing to analyses
+
+_This content is a stub._
+
 This section will contain information about how to create or contribute to an analysis.
 This will include all Git-specific instructions.

docs/contributing.md

@@ -20,12 +20,14 @@ To serve the documentation during local development, run `mkdocs serve` from the
 
 Documentation is written as a series of markdown files nested by topic in directories.
 
-- All directories at the top-level inside `docs` will represent **navbar sections.**
+- All directories at the top-level inside `docs` will represent navbar sections.
   - Each top-level directory should contain an `index.md` file with an overall description of what that section contains.
+  - The `index.md` should have an L1 header with the same title as the navbar section.
 - Nested directories within each navbar section represent a given overall topic.
-  - Markdown files in each directory represent documentation section.
-  - As needed, there can be additional nested directories here.
-- Any visual aids using in your docs should be placed in the `img` directory, in the top-level inside `docs`.
+  - Markdown files in each directory represent sections shown along the left sidebar.
+  - We also expect additional nested directories within navbar directories.
+    - Nested directories should be used to add an additional bold header on the left sidebar.
+- Any visual aids used in the docs should be placed in `docs/img`.
 
 ### Adding new documentation
 

docs/software-platforms/index.md

@@ -1 +1,5 @@
+# Software platforms
+
+_This content is a stub._
+
 This section will contain documentation for using LSfR, AWS, and Docker.

docs/technical-setup/index.md

@@ -1 +1,5 @@
+# Technical setup
+
+_This content is a stub._
+
 This section will contain documentation for the technical aspects of setup, including forking/cloning and setting up your local environment.

docs/troubleshooting-faq/index.md

@@ -1 +1,5 @@
+# Getting Help and FAQ
+
+_This content is a stub._
+
 This section will contain troubleshooting scenarios and an FAQ page.

docs/welcome/index.md

@@ -0,0 +1,6 @@
+# Welcome to OpenScPCA
+
+_This content is a stub._
+
+This section will serve as the documentation landing page.
+It will present an overview of the project, including its goals and information on ways to contribute.

mkdocs.yml

@@ -9,11 +9,11 @@ theme:
   name: material
   features:
     - content.code.copy      # code copy button in code blocks
+    - search.suggest         # displays in light gray how you might complete the word
     - navigation.tabs        # persistent navbar on the top
     - navigation.tabs.sticky # sticky navbar
     - navigation.sections    # enables sections along the left side bar via nested directories in docs/
     - navigation.indexes     # do the thing we want
-    - search.suggest         # displays in light gray how you might complete the word
 
 plugins:
   - search  # search bar
@@ -30,7 +30,7 @@ plugins:
 # Currently, we have templated out the follow navbar items (specific names TBD)
 nav:
   - Welcome to OpenScPCA:      # welcome, familiarizing yourself with the project
-    - landing-page/index.md
+    - welcome/index.md
   - Technical setup:           # Fork/clone, local environment setup
     - technical-setup/index.md
   - Tools for communication:   # Slack, issues, discussions