Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restructure developer guide and add architecture overview #1906

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

stefanv
Copy link

@stefanv stefanv commented Mar 8, 2025

Hi folks 👋!

I'm a developer from the Scientific Python ecosystem, who is new to mystmd, but who has some experience in building documentation tools. Such as the original SciPy Proceedings machinery, that y'all have now replaced with something so much better :)

I am a maintainer of the Scientific Python Hugo Theme, used for projects like NumPy, SciPy, etc. We are investigating moving from Hugo to mystmd, and I'm learning the mystmd stack to determine what that pathway looks like. I.e., I am particularly interested in myst-theme and landing pages.

As I'm learning, I thought it might be useful to help update the developer onboarding material, to soften the landing for those who come after me.

I must apologize in advance: it is entirely possible that I may still have some fairly fundamental misunderstandings, but I hope the proposed structure / concepts / edits are useful, and that we can iterate to find some useful additions. I am not attached to any of the material I submit here, and happy to pivot at your direction.

I've marked all areas that I know need feedback with an error directive, so you can easily locate them. Thank you in advance for your feedback!

Copy link

changeset-bot bot commented Mar 8, 2025

⚠️ No Changeset found

Latest commit: 5ba662b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

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