Skip to content

Commit 2bc341b

Browse files
committed
config: populate myst.yml site metadata
Port description, nav, domain, and logo from config.yaml. Rename static/ → assets/ (Hugo directory convention; MyST does not serve static/ automatically — assets/ is the expected path). No dark logo or favicon: neither existed in the Hugo static/ dir; MyST supplies a default favicon. Footer/quicklinks deferred per ADR 0005.
1 parent f1767ca commit 2bc341b

3 files changed

Lines changed: 27 additions & 5 deletions

File tree

docs/decisions/0001-myst-migration/PLAN.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -210,17 +210,25 @@ Goal: `myst.yml` carries the metadata that used to live in
210210
`config.yaml`, **except** for what we explicitly deferred (footer,
211211
quicklinks).
212212
213+
**Execution note:** commit 1 was done immediately before Phase 7 to
214+
preserve `config.yaml` as a reference before deletion. Commit 2 remains
215+
deferred pending follow-up issue filing.
216+
213217
### Commits
214218
215219
1. `config: populate myst.yml site metadata`
216-
- Files: `myst.yml`
217-
- Add `site.title`, `site.domain`, `site.description`,
218-
`site.options.logo`, `site.options.logo_dark`, `site.options.favicon`,
219-
and `nav:` from `config.yaml`'s `params.navbar`.
220+
- Files: `myst.yml`, `assets/images/logo.svg` (renamed from `static/images/logo.svg`)
221+
- Add `project.description`, `site.options.domain`, `site.nav`,
222+
and `site.options.logo` from `config.yaml`'s `params`.
223+
- `site.options.logo_dark` omitted — no dark logo exists in the repo.
224+
- `site.options.favicon` omitted — MyST provides a default favicon;
225+
no `favicon.ico` was present in the Hugo `static/` directory either.
226+
- Rename `static/` → `assets/` (Hugo directory convention → MyST
227+
convention; MyST does not serve `static/` automatically).
220228
- Why: feature parity for everything except footer/quicklinks, which
221229
ADR 0005 defers.
222230
223-
2. `config: document deferred footer/quicklinks`
231+
2. `config: document deferred footer/quicklinks` _(deferred)_
224232
- Files: add a comment block at the bottom of `myst.yml` with
225233
footer/quicklinks deferred, including the actual follow-up issue
226234
numbers.
@@ -362,6 +370,7 @@ Goal: a fresh clone has no Hugo references.
362370
assets); add `_build/`. Keep `public/` (`html-all` writes there).
363371
`*~` and `.DS_Store` remain unchanged.
364372
- Why: clean working tree.
373+
- Note: `static/` → `assets/` rename was done in Phase 4 commit 1.
365374
366375
### Verification
367376

myst.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ version: 1
33
project:
44
id: 97f4bf9c-5845-4aac-aa8d-1051725d9067 # fixed UUID; MyST regenerates on each build without this, breaking caching
55
title: Learn Scientific Python
6+
description: Documentation for the Scientific Python community.
67
exclude:
78
- external-content/**
89
- themes/**
@@ -43,3 +44,15 @@ project:
4344

4445
site:
4546
title: Learn Scientific Python
47+
nav:
48+
- title: Home
49+
url: https://scientific-python.org/
50+
- title: Blog
51+
url: https://blog.scientific-python.org
52+
- title: Learn
53+
url: https://learn.scientific-python.org/
54+
- title: Tools
55+
url: https://tools.scientific-python.org
56+
options:
57+
domain: learn.scientific-python.org
58+
logo: assets/images/logo.svg

0 commit comments

Comments
 (0)