Skip to content

Commit 9751fe5

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 84589f9 commit 9751fe5

4 files changed

Lines changed: 62 additions & 46 deletions

File tree

content/myst.yml

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
version: 1
2+
3+
project:
4+
id: 97f4bf9c-5845-4aac-aa8d-1051725d9067 # fixed UUID; MyST regenerates on each build without this, breaking caching
5+
title: Learn Scientific Python
6+
description: Documentation for the Scientific Python community.
7+
toc:
8+
- file: index.md
9+
- file: about/index.md
10+
children:
11+
- file: about/governance.md
12+
- file: contributors/index.md
13+
children:
14+
- file: contributors/getting-started.md
15+
- file: contributors/choosing-a-project.md
16+
- file: contributors/why-contribute.md
17+
- file: contributors/ways-to-contribute.md
18+
- file: contributors/first-contribution.md
19+
- title: Setup
20+
children:
21+
- file: contributors/setup/install.md
22+
- file: contributors/setup/ecosystem.md
23+
- file: contributors/setup/next-steps.md
24+
- file: community/index.md
25+
children:
26+
- file: community/role.md
27+
- file: community/onboarding.md
28+
- file: community/skills.md
29+
- file: community/project-management.md
30+
- file: community/community-meetings.md
31+
- file: community/community-outreach.md
32+
- file: documentation/index.md
33+
children:
34+
- file: documentation/accessible-documentation.md
35+
- file: maintainers/index.md
36+
children:
37+
- file: maintainers/interacting-with-new-contributors.md
38+
- file: maintainers/managing-conflict.md
39+
- file: maintainers/meeting_types.md
40+
- file: roadmap.md
41+
42+
site:
43+
title: Learn Scientific Python
44+
nav:
45+
- title: Home
46+
url: https://scientific-python.org/
47+
- title: Blog
48+
url: https://blog.scientific-python.org
49+
- title: Learn
50+
url: https://learn.scientific-python.org/
51+
- title: Tools
52+
url: https://tools.scientific-python.org
53+
options:
54+
domain: learn.scientific-python.org
55+
logo: ../assets/images/logo.svg
56+
folders: true

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

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,6 +217,10 @@ Goal: `myst.yml` carries the metadata that used to live in
217217
`config.yaml`, **except** for what we explicitly deferred (footer,
218218
quicklinks).
219219
220+
**Execution note:** commit 1 was done immediately before Phase 7 to
221+
preserve `config.yaml` as a reference before deletion. Commit 2 remains
222+
deferred pending follow-up issue filing.
223+
220224
### Commits
221225
222226
1. `config: populate myst.yml site metadata`
@@ -231,7 +235,7 @@ quicklinks).
231235
- Why: feature parity for everything except footer/quicklinks, which
232236
ADR 0005 defers.
233237
234-
2. `config: document deferred footer/quicklinks`
238+
2. `config: document deferred footer/quicklinks` _(deferred)_
235239
- Files: add a comment block at the bottom of `myst.yml` with
236240
footer/quicklinks deferred, including the actual follow-up issue
237241
numbers.
@@ -373,6 +377,7 @@ Goal: a fresh clone has no Hugo references.
373377
assets); add `content/_build/`. Keep `public/` (`html-all` writes there).
374378
`*~` and `.DS_Store` remain unchanged.
375379
- Why: clean working tree.
380+
- Note: `static/` → `assets/` rename was done in Phase 4 commit 1.
376381
377382
### Verification
378383

myst.yml

Lines changed: 0 additions & 45 deletions
This file was deleted.

0 commit comments

Comments
 (0)