mystmd icon indicating copy to clipboard operation
mystmd copied to clipboard

🐛 Fix options key present with parts during JB 1 upgrade

Open bryanwweber opened this issue 10 months ago • 3 comments

  • fix: allow options key in toc with parts

Closes #1796

bryanwweber avatar Jan 22 '25 16:01 bryanwweber

⚠️ No Changeset found

Latest commit: a359beb11a059a158be57b15b4e3f8017df0ee0e

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

changeset-bot[bot] avatar Jan 22 '25 16:01 changeset-bot[bot]

We definitely should loosen the strictness of TOC handling during upgrade. However, I think the proper solution is to do this in the validation step: https://github.com/jupyter-book/mystmd/blob/fad8f6730b6461cb70cafb1b2960f4a0dd13c6a7/packages/myst-cli/src/init/jupyter-book/toc.ts#L172-L176

I will circle around to this shortly.

agoose77 avatar Jan 27 '25 15:01 agoose77

We definitely should loosen the strictness of TOC handling during upgrade. However, I think the proper solution is to do this in the validation step: https://github.com/jupyter-book/mystmd/blob/fad8f6730b6461cb70cafb1b2960f4a0dd13c6a7/packages/myst-cli/src/init/jupyter-book/toc.ts#L172-L176

I will circle around to this shortly.

Thanks! I'd written to Rowan on discord, I tried to find a way to get Zod to issue a warning, but it doesn't really support that: https://discord.com/channels/1083088970059096114/1177359316886503464/1331659677485891664

bryanwweber avatar Jan 27 '25 18:01 bryanwweber