-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
70e9e75
commit d00c566
Showing
7 changed files
with
43 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
This section will contain information about communications, including using Slack, GitHub Issues, and GitHub Discussions. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
This section will contain information about how to create or contribute to an analysis. | ||
This will include all Git-specific instructions. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
This section will serve as the documentation landing page. | ||
It will present an overview of the project and its goals as well as information on ways to contribute. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
This section will contain documentation for using LSfR, AWS, and Docker. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
This section will contain documentation for the technical aspects of setup, including forking/cloning and setting up your local environment. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
This section will contain troubleshooting scenarios and an FAQ page. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,45 @@ | ||
site_name: OpenScPCA Documentation | ||
|
||
nav: | ||
- index.md | ||
|
||
exclude_docs: | # syntax: https://www.mkdocs.org/user-guide/configuration/#exclude_docs | ||
/contributing.md # docs contribution guidelines | ||
/requirements.txt # docs requirements file. | ||
/contributing.md # docs contribution guidelines | ||
/requirements.txt # docs requirements file | ||
theme: | ||
name: material | ||
features: | ||
- content.code.copy # code copy button in code blocks | ||
- navigation.tabs # persistent navbar on the top | ||
- search.suggest # displays in light gray how you might complete the word | ||
- content.code.copy # code copy button in code blocks | ||
- 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 | ||
|
||
# Here is the basic structure of our navigation setup. | ||
#nav: | ||
# - Navbar section: <!-- Contents for this navbar section are stored in the directory called `section-path` --> | ||
# - section-path/index.md | ||
# - section-path/markdown-1.md <!-- left sidebar will display H1 title from the markdown file itself --> | ||
# - section-path/markdown-2.md | ||
# - Subsection name: <!-- This title appears as bold item in left sidebar --> | ||
# - section-path/subsection-path/markdown-3.md | ||
|
||
# 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 | ||
- Technical setup: # Fork/clone, local environment setup | ||
- technical-setup/index.md | ||
- Tools for communication: # Slack, issues, discussions | ||
- communications-tools/index.md | ||
- Contributing to analyses: # Setting up an analysis, all the git stuff | ||
- contributing-to-analyses/index.md | ||
- Software platforms: # LSfR, AWS, Docker, etc | ||
- software-platforms/index.md | ||
- Getting Help and FAQ: # troubleshooting and FAQ | ||
- troubleshooting-faq/index.md | ||
|
||
|