Skip to content

refactor: GH-158 proper theme, mkdocs-tacc#240

Merged
wesleyboar merged 14 commits into
epic/v3from
refactor/gh-158-proper-theme
Dec 9, 2025
Merged

refactor: GH-158 proper theme, mkdocs-tacc#240
wesleyboar merged 14 commits into
epic/v3from
refactor/gh-158-proper-theme

Conversation

@wesleyboar
Copy link
Copy Markdown
Collaborator

@wesleyboar wesleyboar commented Dec 8, 2025 •
edited
Loading

Overview

Invisible upgrade to use mkdocs-tacc theme. Merits a v3 release.

Related

Changes

For Readers

  • see [↗] after links to webpages outside the user guide

For Contributors

  • moved /user-guide/docs/ → /user-guide/
  • moved /user-guide/mkdocs.yaml → /mkdocs.yaml

For Developers

  • everything, except:
    • docs/ user-facing .md content
    • .github workflows & templates
    • most styles

Testing

  1. I followed https://tacc.github.io/mkdocs-tacc/test/. Updates made.
  2. I checked /user-guide/docs links. I updated those affected by move.
  3. I tested some internal links on https://pprd.designsafe-ci.org/user-guide/curating/policies.

UI

See https://pprd.designsafe-ci.org/user-guide/.

@wesleyboar
docs: upgrade user/dev instructions
3b8ae3d
@wesleyboar
conf: upgrade
1b406db
@wesleyboar
refactor: move docs to root
195ba2e
@wesleyboar
docs: explain the dir with empty __init__.py
9f9eee9 
To allow PIP and Python to use the same reference for dependencies:
1. For PIP, make package an app (have `our_project_name/__init__.py`).
2. For Poetry, to be explicit, add `package-mode = true`.

This has been done on other clients and template client repo.
@wesleyboar
deps: mkdocs-tacc v1
c68c84d
@wesleyboar wesleyboar marked this pull request as draft December 8, 2025 21:01
@wesleyboar wesleyboar changed the title refactor: gh 158 proper theme refactor: GH-158 proper theme, mkdocs-tacc Dec 8, 2025
@wesleyboar wesleyboar marked this pull request as ready for review December 9, 2025 00:27
@wesleyboar wesleyboar changed the base branch from main to epic/v3 December 9, 2025 16:52
@wesleyboar wesleyboar merged commit 4d33c8d into epic/v3 Dec 9, 2025
1 check passed
@wesleyboar wesleyboar deleted the refactor/gh-158-proper-theme branch December 9, 2025 16:52
This was referenced Dec 9, 2025
Closed
Merged
wesleyboar added a commit that referenced this pull request Dec 10, 2025
@wesleyboar
refactor: v3 (GH-158, GH-61) mkdocs-tacc theme, netlify deploys (#246)
2117d26 
## Overview

- Support TACC theme properly.
- Support live preview server for each PR.
- Set version to `3.0.0`.

## Changes

- #240
  - #241
- #243
  - #244
- #245
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@silviamazzoni silviamazzoni Awaiting requested review from silviamazzoni

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Use MkDocs-TACC Theme, Not Docker + Script

1 participant

@wesleyboar