Skip to content

fix(docs): swap caution and warning admonitions & theme update - #179

Open
wesleyboar wants to merge 7 commits into
mainfrom
fix/admonition-caution-warning-swap
Open

wesleyboar wants to merge 7 commits into
mainfrom
fix/admonition-caution-warning-swap

Conversation

@wesleyboar

@wesleyboar wesleyboar commented Oct 5, 2026 •

Copy link
Copy Markdown
Member

Overview

Important

Swaps !!! caution and !!! warning in source text, so red/yellow does not change for user since I swapped the colors in the theme. If author wants the colors to change… I'll undo the text swaps.

What? Why?

Admonitions, i.e. —

!!! caution
    Important text in a box.

— were using yellow for caution and red for warning, because of a mistake long ago. I fixed the mistake upstream. To make sure TACC-Docs does not swap colors, I update !!! caution to use !!! warning, and vice-versa.

Important

Changes link aliases from https://docs.tacc.utexas.edu/ to /, so those links are not interpreted as absolute links be improvement to script that identifies external links._

What? Why?

There is a script that identifies external links, then:

  • appends [↗] to them
  • makes them open in a new window

That script now interprets http:// and https:// as external links (because it is simpler, reliable logic) but expects —

  • authors to not use http:// and https:// for links on the same domain

— yet many links to pages on this same docs site are (unnecessarily) using http:// and https://.

Note

Accesibility changes:

  • <h1> titles now darker (match body text)
  • hyperlinks now brighter (distinct from text)

Related

Changes

  • changed admonition types across docs:
    • HPC
    • basics
    • software
    • code-example

Testing

Admonitions

  1. Start server.

  2. Compare —

    — purge policy stays red

Core-Styles 2.37 → 2.59

  1. Verify no changes here:

UI

Admonitions

before after
TACC before TACC after

wesleyboar added a commit to TACC/Core-Styles that referenced this pull request Oct 7, 2026
## Overview

Swaps admonition `caution` and `warning` styling and demo use-case copy
so severity matches typical interpretation.

> [!CAUTION]
> **Must update all clients, because this is a breaking change** and I
don't want to bump major version.

## Related

required by:
- TACC/mkdocs-tacc#43
- TACC/Core-CMS#1247
- TACC/TACC-Docs#179
- DesignSafe-CI/DS-User-Guide#293

## Changes

- **fixed** `admonition` caution vs warning message-type mapping and
icon
- **updated** admonition demo `config.yml` use cases
- **updated** `dist` build output

## Testing

1. `make start` (or ensure Fractality is on port 3000 with this branch
checked out).
2. Open http://127.0.0.1:3000/components/detail/admonition
3. Confirm **Caution** is red (error) and **Warning** is yellow
(warning).

## UI

| Before | After |
| - | - |
| <img width="760" alt="Admonition caution and warning (before)"
src="https://github.com/user-attachments/assets/16e4cc0f-29df-4cb1-b99f-019deb39c14e"
/> | <img width="760" alt="Admonition caution and warning (after)"
src="https://github.com/user-attachments/assets/775f0a19-e328-4cf8-9def-d824efa3eb29"
/> |

Co-authored-by: Cursor <[email protected]>
Preserve on-screen severity after Core-Styles and mkdocs-tacc correct caution vs warning styling.

Co-authored-by: Cursor <[email protected]>
wesleyboar added a commit to TACC/mkdocs-tacc that referenced this pull request Oct 7, 2026
## Overview

Aligns admonition caution/warning styling with Core-Styles and bumps the
theme CDN to **2.59.1**.

## Related

requires:
- TACC/Core-Styles#758
- https://github.com/TACC/Core-Styles/releases/tag/v2.59.1

required by:
- TACC/TACC-Docs#179
- DesignSafe-CI/DS-User-Guide#293

## Changes

- **swapped** `pymdownx.css` caution vs warning icons
- **updated** CDN pins for `core-styles.base.css` and
`core-styles.docs.css`
- **swapped** `extensions.md` caution vs warning usage
- **updated** theme version to **1.0.5**

## Testing

1. Start server using this branch.
2. Open `/extensions`.
3. Verify admonitions: **caution** red, **warning** yellow.
4. Verify: no other style changes.

## UI

| Before | After |
| - | - |
| <img width="757" alt="Admonition caution and warning (before)"
src="https://github.com/user-attachments/assets/e1d64e90-fc74-4b1b-ab55-d9bd2a736547"
/> | <img width="757" alt="Admonition caution and warning (after)"
src="https://github.com/user-attachments/assets/133be934-a6e6-4544-8ebc-1e2d2603f0d4"
/> |

---------

Co-authored-by: Cursor <[email protected]>
@wesleyboar
wesleyboar force-pushed the fix/admonition-caution-warning-swap branch from b0f6037 to fcba145 Compare October 7, 2026 22:29
wesleyboar and others added 2 commits October 7, 2026 17:42
Lock to the published RC with admonition CDN fixes ahead of 1.0.5 stable.

Co-authored-by: Cursor <[email protected]>
Refresh lock for RC with Core-Styles 2.59.2 heading fix.

Co-authored-by: Cursor <[email protected]>
@wesleyboar
wesleyboar requested review from susanunit and removed request for susanunit October 8, 2026 03:15
@wesleyboar
wesleyboar marked this pull request as draft October 8, 2026 03:26
wesleyboar and others added 3 commits October 7, 2026 22:40
Merge theme lock from chore branch into admonition PR.
Special case: not part of caution/warning swap.

Co-authored-by: Cursor <[email protected]>
@wesleyboar

Copy link
Copy Markdown
Member Author

@susanunit, big changes. We should chat first. Not urgent.

@wesleyboar wesleyboar changed the title fix(docs): swap caution and warning admonitions fix(docs): swap caution and warning admonitions & theme update Oct 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant