Skip to content

(chore) reverse docs-theme dependency direction#8005

Draft
cameronjoyner wants to merge 3 commits intodevelopfrom
cj/markdown-plugin-pt1
Draft

(chore) reverse docs-theme dependency direction#8005
cameronjoyner wants to merge 3 commits intodevelopfrom
cj/markdown-plugin-pt1

Conversation

@cameronjoyner
Copy link
Copy Markdown
Contributor

@cameronjoyner cameronjoyner commented Apr 1, 2026 •
edited
Loading

Changes proposed in this pull request:

  • Reverse the dependency direction between docs-data and docs-theme
  • Export nav tree types, slugify, and MdxPluginData from docs-data
  • Define MdxPluginData in docs-data as the replacement for MarkdownPluginData from @documentalist/client, using our own NavTreeNode[] and DocPage types
  • Migrate all nav tree type usage in docs-theme components from @documentalist/client's to docs-data
  • Add a local isPageNode type guard in documentalistUtils.ts to replace the one from @documentalist/client
  • Inline the DOCS_CODE_BLOCK class constant in markdownRenderer.mjs to remove the docs-theme import from docs-data

@changelog-app
Copy link
Copy Markdown

changelog-app bot commented Apr 1, 2026

Generate changelog in packages/docs-theme/changelog/@unreleased

Type (Select exactly one)

  • Feature (Adding new functionality)
  • Improvement (Improving existing functionality)
  • Fix (Fixing an issue with existing functionality)
  • Break (Creating a new major version by breaking public APIs)
  • Deprecation (Removing functionality in a non-breaking way)
  • Migration (Automatically moving data/functionality to a new system)

Description

(chore) reverse docs-theme dependency direction

Check the box to generate changelog(s)

  • Generate changelog entry

cameronjoyner
cameronjoyner commented Apr 1, 2026
View reviewed changes
packages/docs-theme/package.json
"dependencies": {
"@blueprintjs/colors": "workspace:^",
"@blueprintjs/core": "workspace:^",
"@blueprintjs/docs-data": "workspace:^",
Copy link
Copy Markdown
Contributor Author

@cameronjoyner cameronjoyner Apr 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Notice that docs-theme now depends on docs-data rather than the other way around 👍

Copy link
Copy Markdown
Contributor Author

@cameronjoyner cameronjoyner Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

don't do this

@blueprint-previews
Copy link
Copy Markdown

blueprint-previews bot commented Apr 1, 2026

moving around a function

Build artifact links for this commit: documentation | landing | table | demo | storybook

This is an automated comment from the deploy-preview CircleCI job.

cameronjoyner
cameronjoyner commented Apr 2, 2026
View reviewed changes
packages/docs-data/markdownRenderer.mjs
// @ts-check

import escapeHTML from "escape-html";
import { marked } from "marked";
Copy link
Copy Markdown
Contributor Author

@cameronjoyner cameronjoyner Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This entire file will be remove in a forthcoming PR

@blueprint-previews
Copy link
Copy Markdown

blueprint-previews bot commented Apr 2, 2026

fix slugify index.js import

Build artifact links for this commit: documentation | landing | table | demo | storybook

This is an automated comment from the deploy-preview CircleCI job.

@blueprint-previews
Copy link
Copy Markdown

blueprint-previews bot commented Apr 2, 2026

reverting some of my changes

Build artifact links for this commit: documentation | landing | table | demo | storybook

This is an automated comment from the deploy-preview CircleCI job.

@cameronjoyner cameronjoyner force-pushed the cj/markdown-plugin-pt1 branch from 24247dd to 215922e Compare April 2, 2026 19:13
@blueprint-previews
Copy link
Copy Markdown

blueprint-previews bot commented Apr 2, 2026

[core] Add Storybook stories for Forms (#7950)

Build artifact links for this commit: documentation | landing | table | demo | storybook

This is an automated comment from the deploy-preview CircleCI job.

@cameronjoyner cameronjoyner reopened this Apr 2, 2026
cameronjoyner
cameronjoyner commented Apr 2, 2026
View reviewed changes
packages/docs-data/markdownRenderer.mjs
import { marked } from "marked";

import { Classes } from "@blueprintjs/core";
import { Classes as DocsClasses } from "@blueprintjs/docs-theme";
Copy link
Copy Markdown
Contributor Author

@cameronjoyner cameronjoyner Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only removed because docs-data doesn't rely on docs-theme anymore

cameronjoyner
cameronjoyner commented Apr 2, 2026
View reviewed changes
packages/docs-theme/src/components/block.tsx
export function renderBlock(
/** the block to render */
block: Block | undefined,
block: Block | DocPage | undefined,
Copy link
Copy Markdown
Contributor Author

@cameronjoyner cameronjoyner Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added here instead of adding conditional logic to packages/docs-theme/src/components/page.tsx because its a bit simpler/more straightforward

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@cameronjoyner