Skip to content

Preserve all installation steps when converting documentation. - #67

Open
Floating-Y wants to merge 2 commits into
deeplethe:devfrom
Floating-Y:fix/docs-install-steps
Open

Floating-Y wants to merge 2 commits into
deeplethe:devfrom
Floating-Y:fix/docs-install-steps

Conversation

@Floating-Y

Copy link
Copy Markdown
Contributor

Why

CodeTabs conversion dropped Toast's Toaster setup, Attachment's Button command and Calendar's Button prerequisite.

What changes

Preserve Command and Manual as separate ordered block lists, reusing existing parsing and rendering for steps, prose, code, filenames and lazy source loading. Retain compact installation syntax. Add five regression tests to CI without changing upstream MDX, component behavior or generated artifacts.

How it was checked

  • Linux Node 24.21.0: npm ci, 13 Node tests, docs, typecheck and build passed. Five new tests fail against the old converter.
  • git diff --check and registry.json diff check passed.
  • Checked affected documentation in both themes, package-manager switching, copy success feedback and source display.
  • /dev/examples: 389 mounted, 0 failed.
  • Temporary consumer built and displayed toast.add() notifications with Toaster mounted; Calendar and Attachment rendered with Button present.

Limitations: Node 22 was not reproduced locally. Native Windows docs/build hit the existing path-to-slug issue; typecheck lacked the generated catalog. Consumer Button was manually copied, so its CLI installation path was not verified. Toast's upstream Manual also omits its existing Button prerequisite.

Before review

  • Every commit is signed off.
  • Typecheck and build pass in Linux as described above.
  • /dev/examples reports 0 failed.
  • Affected documentation inspected in both themes.

Signed-off-by: danwood <118035379+Floating-Y@users.noreply.github.com>
@WaylandYang

Copy link
Copy Markdown
Collaborator

Thanks for this. Keeping Command and Manual as separate block lists is the right fix, and the regression tests are exactly what we wanted.

We'd like to merge it, but dev requires a branch to be up to date before it merges, and this one is behind. Edits from maintainers aren't allowed on this PR, so we can't update it from our side. Could you either:

  • merge or rebase the latest dev into fix/docs-install-steps, or
  • tick Allow edits by maintainers in the PR sidebar, and we'll update it ourselves.

No conflicts are expected. Since this was opened, dev has only taken #63, #64 and #66, and none of them touch build-docs.mjs or the workflow.

We're merging this one first because #62 and #65 change the same files. Once it's in, we'll fit those two around it. You won't need to change anything for them.

@Floating-Y

Copy link
Copy Markdown
Contributor Author

Thanks for the review! I've updated the branch with the latest dev and rerun the checks. It's ready for another look.

This branch has not been deployed

No deployments
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.

2 participants