Skip to content

Add rich documentation blocks - #173

Merged
clbotdev merged 1 commit into
mainfrom
feat/docs-rich-blocks
Oct 31, 2026
Merged

clbotdev merged 1 commit into
mainfrom
feat/docs-rich-blocks

Conversation

@clbotdev

@clbotdev clbotdev commented Oct 31, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Add rich documentation blocks so Git-sourced docs can retain callouts, tabs, steps, cards, accordions, code groups, and type tables. The editor can author the blocks, Markdown can round-trip them, and published pages render and index their content. Also support code-fence titles and inline code in links and bold text.

Validation

  • Text-editor tests: 110 passed; documentation API tests: 363 passed; package typecheck passed; pre-commit formatting and lint passed.
  • Browser smoke: created and published a document with all seven blocks, checked public rendering and search, then imported nine MediaLit pages through the sync worker with a stubbed GitHub API. Checked tab clicks, arrow-key navigation, and mobile layout.
  • The GitHub App connection was not tested live. Accordion, code-group, card-link and editor interactions still need the additional manual checks identified in the smoke review.
  • Accordion type="single" is preserved but items currently open independently; card icons appear after hydration.

Closes #80

QA deployment smoke

Deployed commit 08c80fc to QA with tag qa-pr173-08c80fc (all three images include linux/arm64). The migration and all three rollouts succeeded. In a dedicated QA workspace, signed in using Mailpit, authored and published all seven blocks, and verified public rendering, tab and code-group switching, accordion expansion, a card link, mobile layout, and search for accordion text. The GitHub App sync was not tested on QA.

@clbotdev
clbotdev marked this pull request as ready for review October 31, 2026 09:16
@clbotdev
clbotdev merged commit 46dccc6 into main Oct 31, 2026
6 checks passed
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.

Docs: rich blocks (Callout, Tabs, Steps, Cards, Accordion, Code group, Type table)

2 participants