Skip to content

Commit 5278996

Browse files
authored
chore: prep for mkdocs-tacc theme (#239)
* docs: css README updates * docs: js README updates * chore: remove config for theme we do not use (yet) The feature is from MkDocs Material theme — https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#back-to-top-button — but we use MkDocs Tacc theme, which skins ReadTheDocs theme. * docs: delete cruft from TACC-Docs v0.15
1 parent dddc705 commit 5278996

4 files changed

Lines changed: 6 additions & 9 deletions

File tree

PUBLISHING.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,3 @@ A Watchtower service will monitor new pushes to this dockerhub repo and pull dow
1717
## Releases
1818

1919
[Releases](https://github.com/DesignSafe-CI/DS-User-Guide/releases) are made when a significant set of **functional** Pull Requests have been merged.
20-
21-
> [!NOTE]
22-
> Releases are only used by clients of the TACC MkDocs [configuration](https://github.com/DesignSafe-CI/DS-User-Guide/blob/v0.14.0/mkdocs.base.yml) and [theme](https://github.com/DesignSafe-CI/DS-User-Guide/tree/v0.14.0/themes/tacc-readthedocs), so changes to the content of documents do **not** merit a release.

user-guide/docs/css/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# DesignSafe User Guide Styles
22

3-
Styles specific to DS-User-Guide should be in this directoy.
4-
Styles any TACC docs should be in https://github.com/TACC/TACC-Docs.
3+
Styles specific to DS-User-Guide should be in this directory.
4+
5+
Styles for all TACC-themed docs belong in https://github.com/TACC/mkdocs-tacc.

user-guide/docs/js/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# DesignSafe User Guide Scripts
22

3-
Scripts specific to DS-User-Guide should be in this directoy.
4-
Scripts any TACC docs should be in https://github.com/TACC/TACC-Docs.
3+
Scripts specific to DS-User-Guide should be in this directory.
4+
5+
Scripts for all TACC-themed docs belong in https://github.com/TACC/mkdocs-tacc.

user-guide/mkdocs.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ theme:
1515
cms_name: designsafe-ci.org # TACC Feature
1616
nav_name: User Guide # TACC Feature
1717
navigation_depth: 6
18-
features:
19-
- navigation.top
2018
analytics:
2119
gtag: G-D96RT1T24K
2220

0 commit comments

Comments
 (0)