Skip to content

Convert to MySTMD#315

Draft
lundybernard wants to merge 2 commits into
scientific-python:mainfrom
lundybernard:lb/myst-migration
Draft

Convert to MySTMD#315
lundybernard wants to merge 2 commits into
scientific-python:mainfrom
lundybernard:lb/myst-migration

Conversation

@lundybernard
Copy link
Copy Markdown

@lundybernard lundybernard commented May 13, 2026

Migrate from Hugo to MyST-MD

Fixes: #279

@netlify
Copy link
Copy Markdown

netlify Bot commented May 13, 2026

Deploy Preview for learn-scientific-python-org ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit af02bd3
🔍 Latest deploy log https://app.netlify.com/projects/learn-scientific-python-org/deploys/6a061dc96e091a0009cc8417
😎 Deploy Preview https://deploy-preview-315--learn-scientific-python-org.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 99
Accessibility: 97
Best Practices: 100
SEO: 100
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@lundybernard
Copy link
Copy Markdown
Author

I've put together a plan for the migration, including REQUIREMENTS.md, and Architectural Decision Records (ADRs), which need review, and a detailed PLAN.md document.

Recommended Review order:

  • Start with REQUIREMENTS.md; a high-level list of goals, and details about how the change will be managed. Any changes to this doc will be top priority.
  • Review the ADRs in docs/decisions/0001-myst-migration/; they cover specific decisions that need to be made, and are the most important items to discuss.
  • The README files just provide context and an index of the directories, and should be helpful.
  • the PLAN.md doc contains a granular specifics, is likely to change as I work through the migration. It is helpful for the process, may be a valuable record of the completed work, but is probably not worth reviewing at this time.

Ai Tools Disclaimer:
These docs were generated using Claude Opus-4.7 for planning and review, Sonet-4.6 for edits, and GPT-5.5 for reviews.
I have read, reviewed, and updated the docs myself many times, and feel that they are ready for other humans to review and discuss.
Since scientific-python.org does not have an official Ai use policy, I'm using the SciPy project's policy as a guideline.

Adds the full planning record for the Hugo → MyST-MD migration to
docs/decisions/0001-myst-migration/:

- REQUIREMENTS.md — what the migration must achieve and why
- PLAN.md — commit-by-commit 8-phase implementation sequence
- 0001–0007 ADR files — one decision per file, all Status: Proposed
- README.md — index of the above

ADR format is used so the decision rationale survives as a reviewable
archive. All ADRs are Proposed pending maintainer review; the plan and
requirements are the working basis for the migration work to follow.
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.

Convert to MySTMD & enable PR previews on RTD

1 participant