Beta.22 docs#150
Conversation
WalkthroughThis update introduces new documentation and plugin support for Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant StudioCMSConfig
participant PluginHTML
participant PluginMD
User->>StudioCMSConfig: Import and configure plugins
StudioCMSConfig->>PluginHTML: Register HTML renderer
StudioCMSConfig->>PluginMD: Register Markdown renderer
StudioCMSConfig-->>User: Plugins enabled for rendering
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~18 minutes Possibly related PRs
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (6)
💤 Files with no reviewable changes (1)
🚧 Files skipped from review as they are similar to previous changes (4)
🧰 Additional context used🧠 Learnings (3)📓 Common learnings📚 Learning: in the withstudiocms/docs repository, documentation urls in the package-catalog may maintain legacy ...Applied to files:
📚 Learning: in the withstudiocms/docs repository, when reviewing french translation files, maintain consistency ...Applied to files:
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
🔇 Additional comments (3)
✨ Finishing Touches
🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
- Added new upgrade guide for version 0.1.0-beta.22. - Introduced new HTML and MD plugins with installation instructions. - Removed outdated badges from various documentation pages. - Updated GitHub URLs for several plugins to reflect new package structure. - Enhanced rendering documentation with additional notes on required plugins. - Added aside notes in relevant sections to clarify plugin dependencies. - Cleaned up code examples and improved formatting across multiple files.
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
…anges, new features, and bug fixes
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
🧹 Nitpick comments (14)
src/content/docs/en/package-catalog/studiocms-plugins/studiocms-blog.mdx (2)
14-14: Import list grows; drop unused imports to avoid dead code
Steps,Tabs, andTabItemare still imported but not referenced anywhere in the document. Removing unused component imports eliminates dead code and tree-shaking overhead.-import { Steps, Tabs, TabItem, Aside } from '@astrojs/starlight/components'; +import { Aside } from '@astrojs/starlight/components';
18-20: Helpful dependency aside – consider linking to setup docsThe added aside clearly states the new dependency, great. You could make it even more actionable by linking to the
@studiocms/mdcatalog page so readers can jump straight to installation instructions.-This plugin requires the `@studiocms/md` plugin. +This plugin requires the [`@studiocms/md`](../studiocms-md/) plugin.src/content/docs/en/package-catalog/studiocms-plugins/studiocms-mdx.mdx (1)
14-15: Unused imports – will trigger build-time lint errors
Steps,Tabs, andTabItemare imported but never used in this document.
Astro/Type-aware MDX pipelines generally treat unused imports as errors/warnings.-import { Steps, Tabs, TabItem, Aside } from '@astrojs/starlight/components'; +import { Aside } from '@astrojs/starlight/components';Remove or use the extra components.
src/content/docs/en/package-catalog/studiocms-plugins/studiocms-markdoc.mdx (1)
14-15: Same unused-import issue as above
Steps,Tabs, andTabItemare imported but not referenced.Apply the same trim-down as suggested for the MDX doc.
src/content/package-catalog/studiocms-html.json (1)
8-9:releasedflag stillfalse– remember to flip before mergeThe PR objectives mention setting
released: trueonce Beta 22 ships.
Add a TODO comment or create a follow-up task so this doesn’t slip through.src/content/docs/en/package-catalog/studiocms-plugins/studiocms-md.mdx (2)
16-20: Prefer “Markdown” over “MD” for clarityLine 18 introduces the plugin as “MD Support”. Throughout the docs we refer to the format as “Markdown”, not “MD”. Consistency helps searchability and avoids confusion with
MDX.
41-60: Type definitions are duplicated – consider extracting a sharedSanitizeOptionsBoth flavor definitions embed an identical
sanitizeobject. Documenting a singletype SanitizeOptions = { … }and referencing it in each flavor (sanitize: SanitizeOptions) reduces doc drift when the shape changes.src/content/docs/en/package-catalog/studiocms-plugins/studiocms-html.mdx (2)
18-20: Minor grammar – “HTML support”, lower-case “support”
HTML Support→HTML supportfor standard capitalization.
41-54: Typo in type alias
type htmlOptions→type HtmlOptions(Pascal-case matches exported type in the package).-type htmlOptions = { +type HtmlOptions = {package.json (1)
88-92:pnpm.overridesforces Vite 6 – add a comment explaining the riskAdd a short rationale (“Required by @studiocms/ui which already depends on Vite 6”) so future maintainers know why this override exists and when it can be removed.
src/content/docs/en/start-here/getting-started.mdx (2)
7-9: Badge layout breaks on narrow viewportsThe new sidebar badge (“Updated”) pushes the title onto two lines at ≤320 px width. Consider
variant='note' size='sm'or moving the badge into the page body.
222-248: Rendering-plugin section is great – add MDX code sample parityWe show a StudioCMS config but some users configure only via
astro.config.mjs. A parallel snippet mirroring the earlier Astro-integrations example would avoid ambiguity.src/content/docs/en/how-it-works/index.mdx (2)
42-44: Link to migration guide for new component registryThe addition of
studiocms:component-registryis significant; a link to the Beta 22 upgrade guide section would help readers migrate custom components quickly.
113-115: Parameterised auth routes: explicitly list supported providersReplacing hard-coded routes with
[provider]is concise but hides the allowed values. Append a short note “(github,discord,auth0today)” to keep discoverability.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (33)
astro.config.mts(1 hunks)ec.config.mjs(2 hunks)knip.config.ts(1 hunks)package.json(2 hunks)src/content/docs/en/config-reference/features.mdx(2 hunks)src/content/docs/en/config-reference/index.mdx(0 hunks)src/content/docs/en/config-reference/locale.mdx(0 hunks)src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-21.mdx(0 hunks)src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-22.mdx(1 hunks)src/content/docs/en/how-it-works/cli.mdx(0 hunks)src/content/docs/en/how-it-works/effect.mdx(0 hunks)src/content/docs/en/how-it-works/index.mdx(2 hunks)src/content/docs/en/how-it-works/sdk.mdx(1 hunks)src/content/docs/en/package-catalog/studiocms-plugins/studiocms-blog.mdx(1 hunks)src/content/docs/en/package-catalog/studiocms-plugins/studiocms-html.mdx(1 hunks)src/content/docs/en/package-catalog/studiocms-plugins/studiocms-markdoc.mdx(1 hunks)src/content/docs/en/package-catalog/studiocms-plugins/studiocms-md.mdx(1 hunks)src/content/docs/en/package-catalog/studiocms-plugins/studiocms-mdx.mdx(1 hunks)src/content/docs/en/plugins/index.mdx(0 hunks)src/content/docs/en/start-here/configuration.mdx(0 hunks)src/content/docs/en/start-here/environment-variables.mdx(0 hunks)src/content/docs/en/start-here/getting-started.mdx(2 hunks)src/content/docs/en/utils/rendering.mdx(1 hunks)src/content/package-catalog/astrojs-web-vitals.json(1 hunks)src/content/package-catalog/studiocms-blog.json(1 hunks)src/content/package-catalog/studiocms-cloudinary-image-service.json(1 hunks)src/content/package-catalog/studiocms-devapps.json(1 hunks)src/content/package-catalog/studiocms-html.json(1 hunks)src/content/package-catalog/studiocms-markdoc.json(1 hunks)src/content/package-catalog/studiocms-md.json(1 hunks)src/content/package-catalog/studiocms-mdx.json(1 hunks)studiocms(1 hunks)typedoc.config.ts(3 hunks)
💤 Files with no reviewable changes (8)
- src/content/docs/en/config-reference/locale.mdx
- src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-21.mdx
- src/content/docs/en/start-here/configuration.mdx
- src/content/docs/en/plugins/index.mdx
- src/content/docs/en/how-it-works/effect.mdx
- src/content/docs/en/config-reference/index.mdx
- src/content/docs/en/start-here/environment-variables.mdx
- src/content/docs/en/how-it-works/cli.mdx
🧰 Additional context used
🧠 Learnings (19)
📓 Common learnings
Learnt from: ArmandPhilippot
PR: withstudiocms/docs#140
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-19.mdx:24-24
Timestamp: 2025-07-21T12:16:32.374Z
Learning: In the withstudiocms/docs repository, documentation URLs in the package-catalog may maintain legacy path names for stability and consistency across language versions, even when the actual package names have been updated. Always verify that corresponding files exist before flagging URLs as broken.
src/content/package-catalog/studiocms-mdx.json (1)
Learnt from: ArmandPhilippot
PR: #140
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-19.mdx:24-24
Timestamp: 2025-07-21T12:16:32.374Z
Learning: In the withstudiocms/docs repository, documentation URLs in the package-catalog may maintain legacy path names for stability and consistency across language versions, even when the actual package names have been updated. Always verify that corresponding files exist before flagging URLs as broken.
src/content/package-catalog/studiocms-cloudinary-image-service.json (1)
Learnt from: ArmandPhilippot
PR: #140
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-19.mdx:24-24
Timestamp: 2025-07-21T12:16:32.374Z
Learning: In the withstudiocms/docs repository, documentation URLs in the package-catalog may maintain legacy path names for stability and consistency across language versions, even when the actual package names have been updated. Always verify that corresponding files exist before flagging URLs as broken.
src/content/package-catalog/studiocms-devapps.json (1)
Learnt from: ArmandPhilippot
PR: #140
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-19.mdx:24-24
Timestamp: 2025-07-21T12:16:32.374Z
Learning: In the withstudiocms/docs repository, documentation URLs in the package-catalog may maintain legacy path names for stability and consistency across language versions, even when the actual package names have been updated. Always verify that corresponding files exist before flagging URLs as broken.
studiocms (2)
Learnt from: ArmandPhilippot
PR: #149
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-21.mdx:13-15
Timestamp: 2025-07-24T11:57:15.225Z
Learning: In the withstudiocms/docs repository, when reviewing French translation files, maintain consistency with the English version even if it means keeping unused imports. Structural parity between language versions is prioritized over removing unused code.
Learnt from: ArmandPhilippot
PR: #140
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-19.mdx:24-24
Timestamp: 2025-07-21T12:16:32.374Z
Learning: In the withstudiocms/docs repository, documentation URLs in the package-catalog may maintain legacy path names for stability and consistency across language versions, even when the actual package names have been updated. Always verify that corresponding files exist before flagging URLs as broken.
src/content/package-catalog/studiocms-blog.json (1)
Learnt from: ArmandPhilippot
PR: #140
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-19.mdx:24-24
Timestamp: 2025-07-21T12:16:32.374Z
Learning: In the withstudiocms/docs repository, documentation URLs in the package-catalog may maintain legacy path names for stability and consistency across language versions, even when the actual package names have been updated. Always verify that corresponding files exist before flagging URLs as broken.
src/content/docs/en/utils/rendering.mdx (1)
Learnt from: ArmandPhilippot
PR: #140
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-19.mdx:24-24
Timestamp: 2025-07-21T12:16:32.374Z
Learning: In the withstudiocms/docs repository, documentation URLs in the package-catalog may maintain legacy path names for stability and consistency across language versions, even when the actual package names have been updated. Always verify that corresponding files exist before flagging URLs as broken.
astro.config.mts (1)
Learnt from: ArmandPhilippot
PR: #140
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-19.mdx:24-24
Timestamp: 2025-07-21T12:16:32.374Z
Learning: In the withstudiocms/docs repository, documentation URLs in the package-catalog may maintain legacy path names for stability and consistency across language versions, even when the actual package names have been updated. Always verify that corresponding files exist before flagging URLs as broken.
src/content/package-catalog/studiocms-html.json (1)
Learnt from: ArmandPhilippot
PR: #140
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-19.mdx:24-24
Timestamp: 2025-07-21T12:16:32.374Z
Learning: In the withstudiocms/docs repository, documentation URLs in the package-catalog may maintain legacy path names for stability and consistency across language versions, even when the actual package names have been updated. Always verify that corresponding files exist before flagging URLs as broken.
src/content/docs/en/package-catalog/studiocms-plugins/studiocms-md.mdx (1)
Learnt from: ArmandPhilippot
PR: #140
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-19.mdx:24-24
Timestamp: 2025-07-21T12:16:32.374Z
Learning: In the withstudiocms/docs repository, documentation URLs in the package-catalog may maintain legacy path names for stability and consistency across language versions, even when the actual package names have been updated. Always verify that corresponding files exist before flagging URLs as broken.
src/content/package-catalog/astrojs-web-vitals.json (1)
Learnt from: ArmandPhilippot
PR: #140
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-19.mdx:24-24
Timestamp: 2025-07-21T12:16:32.374Z
Learning: In the withstudiocms/docs repository, documentation URLs in the package-catalog may maintain legacy path names for stability and consistency across language versions, even when the actual package names have been updated. Always verify that corresponding files exist before flagging URLs as broken.
package.json (1)
Learnt from: ArmandPhilippot
PR: #140
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-19.mdx:24-24
Timestamp: 2025-07-21T12:16:32.374Z
Learning: In the withstudiocms/docs repository, documentation URLs in the package-catalog may maintain legacy path names for stability and consistency across language versions, even when the actual package names have been updated. Always verify that corresponding files exist before flagging URLs as broken.
src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-22.mdx (1)
Learnt from: ArmandPhilippot
PR: #140
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-19.mdx:24-24
Timestamp: 2025-07-21T12:16:32.374Z
Learning: In the withstudiocms/docs repository, documentation URLs in the package-catalog may maintain legacy path names for stability and consistency across language versions, even when the actual package names have been updated. Always verify that corresponding files exist before flagging URLs as broken.
src/content/package-catalog/studiocms-markdoc.json (1)
Learnt from: ArmandPhilippot
PR: #140
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-19.mdx:24-24
Timestamp: 2025-07-21T12:16:32.374Z
Learning: In the withstudiocms/docs repository, documentation URLs in the package-catalog may maintain legacy path names for stability and consistency across language versions, even when the actual package names have been updated. Always verify that corresponding files exist before flagging URLs as broken.
typedoc.config.ts (2)
Learnt from: ArmandPhilippot
PR: #140
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-19.mdx:24-24
Timestamp: 2025-07-21T12:16:32.374Z
Learning: In the withstudiocms/docs repository, documentation URLs in the package-catalog may maintain legacy path names for stability and consistency across language versions, even when the actual package names have been updated. Always verify that corresponding files exist before flagging URLs as broken.
Learnt from: ArmandPhilippot
PR: #149
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-21.mdx:13-15
Timestamp: 2025-07-24T11:57:15.225Z
Learning: In the withstudiocms/docs repository, when reviewing French translation files, maintain consistency with the English version even if it means keeping unused imports. Structural parity between language versions is prioritized over removing unused code.
src/content/package-catalog/studiocms-md.json (1)
Learnt from: ArmandPhilippot
PR: #140
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-19.mdx:24-24
Timestamp: 2025-07-21T12:16:32.374Z
Learning: In the withstudiocms/docs repository, documentation URLs in the package-catalog may maintain legacy path names for stability and consistency across language versions, even when the actual package names have been updated. Always verify that corresponding files exist before flagging URLs as broken.
src/content/docs/en/package-catalog/studiocms-plugins/studiocms-html.mdx (1)
Learnt from: ArmandPhilippot
PR: #140
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-19.mdx:24-24
Timestamp: 2025-07-21T12:16:32.374Z
Learning: In the withstudiocms/docs repository, documentation URLs in the package-catalog may maintain legacy path names for stability and consistency across language versions, even when the actual package names have been updated. Always verify that corresponding files exist before flagging URLs as broken.
src/content/docs/en/start-here/getting-started.mdx (1)
Learnt from: ArmandPhilippot
PR: #140
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-19.mdx:24-24
Timestamp: 2025-07-21T12:16:32.374Z
Learning: In the withstudiocms/docs repository, documentation URLs in the package-catalog may maintain legacy path names for stability and consistency across language versions, even when the actual package names have been updated. Always verify that corresponding files exist before flagging URLs as broken.
src/content/docs/en/how-it-works/index.mdx (1)
Learnt from: ArmandPhilippot
PR: #140
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-19.mdx:24-24
Timestamp: 2025-07-21T12:16:32.374Z
Learning: In the withstudiocms/docs repository, documentation URLs in the package-catalog may maintain legacy path names for stability and consistency across language versions, even when the actual package names have been updated. Always verify that corresponding files exist before flagging URLs as broken.
🔇 Additional comments (29)
src/content/package-catalog/astrojs-web-vitals.json (1)
4-4: Verify new package name – potential typo/inconsistencyThe replacement package is referenced as
@withstudiocms/web-vitals, whereas the rest of the code-base (e.g.@studiocms/html,@studiocms/md) uses the@studiocms/…scope.
Double-check that the published package is indeed scoped to@withstudiocms/*; if it is actually@studiocms/web-vitals, update this description (and any related docs/links) to avoid broken install commands.knip.config.ts (1)
7-8: LGTM – new plugins correctly ignoredAdding
@studiocms/htmland@studiocms/mdtoignoreDependencieskeeps Knip noise down while these packages remain dev-only. No further action needed.studiocms (1)
1-1: Verify the submodule SHA maps to the intended Beta.22 tag
The pointer now references commit35664a7. Please double-check that:
- This commit is the exact SHA on the
studiocmsrepo that corresponds to the published Beta.22 release tag (or another immutable release reference).- CI and downstream consumers can fetch this commit (i.e., it’s on a public branch or tag, not an ephemeral feature branch).
If a release tag exists, consider updating the submodule to that tag instead of a raw SHA for clearer traceability.
src/content/package-catalog/studiocms-mdx.json (1)
6-6: Update remaining legacy path in contributors.config.tsA repo scan found one lingering reference to the old underscore-based folder. Please update it to the new scoped path:
• File:
src/util/contributors.config.ts(line 79)- 'packages/studiocms_mdx/', + 'packages/@studiocms/mdx/',This will ensure all links use the updated directory structure.
⛔ Skipped due to learnings
Learnt from: ArmandPhilippot PR: withstudiocms/docs#140 File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-19.mdx:24-24 Timestamp: 2025-07-21T12:16:32.374Z Learning: In the withstudiocms/docs repository, documentation URLs in the package-catalog may maintain legacy path names for stability and consistency across language versions, even when the actual package names have been updated. Always verify that corresponding files exist before flagging URLs as broken.Learnt from: ArmandPhilippot PR: withstudiocms/docs#149 File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-21.mdx:13-15 Timestamp: 2025-07-24T11:57:15.225Z Learning: In the withstudiocms/docs repository, when reviewing French translation files, maintain consistency with the English version even if it means keeping unused imports. Structural parity between language versions is prioritized over removing unused code.src/content/package-catalog/studiocms-blog.json (1)
6-6: Update blog package path in contributors.config.tsA remaining reference to the old directory needs updating:
- File:
src/util/contributors.config.ts(line 78)
Replace:- 'packages/studiocms_blog/', + 'packages/@studiocms/blog/',⛔ Skipped due to learnings
Learnt from: ArmandPhilippot PR: withstudiocms/docs#140 File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-19.mdx:24-24 Timestamp: 2025-07-21T12:16:32.374Z Learning: In the withstudiocms/docs repository, documentation URLs in the package-catalog may maintain legacy path names for stability and consistency across language versions, even when the actual package names have been updated. Always verify that corresponding files exist before flagging URLs as broken.Learnt from: ArmandPhilippot PR: withstudiocms/docs#149 File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-21.mdx:13-15 Timestamp: 2025-07-24T11:57:15.225Z Learning: In the withstudiocms/docs repository, when reviewing French translation files, maintain consistency with the English version even if it means keeping unused imports. Structural parity between language versions is prioritized over removing unused code.src/content/package-catalog/studiocms-cloudinary-image-service.json (1)
5-7:docsLinkslug mismatch – please double-check the pathThe JSON entry is for
@studiocms/cloudinary-image-service, yetdocsLinkpoints to
/package-catalog/studiocms-plugins/studiocms-cloudinary-js/.Unless the documentation really lives under the
cloudinary-jsslug (legacy naming), this will render a broken link in the catalog UI.If the slug is historical, add an inline comment explaining the divergence so future maintainers don’t “fix” it accidentally.
src/content/docs/en/package-catalog/studiocms-plugins/studiocms-mdx.mdx (1)
20-22: Good call-out!The
<Aside>block clearly states the new hard dependency on@studiocms/md. Nice addition.src/content/docs/en/package-catalog/studiocms-plugins/studiocms-markdoc.mdx (1)
20-22: Dependency note looks goodClear communication of the
@studiocms/mdprerequisite.src/content/docs/en/how-it-works/sdk.mdx (1)
28-34: Sample code may no longer run – environment no longer providedPreviously the snippet explicitly called
.pipe(Effect.provide(SDKCore.Default)).
With that removed,runSDK(pagesEffect)must supply anSDKCorelayer implicitly. IfrunSDKdoesn’t auto-provide, newcomers will hit an unhelpful runtime error.Consider either:
- Restoring the explicit
provide, or- Adding a short note that
runSDKwires the environment for you.src/content/docs/en/config-reference/features.mdx (1)
217-217: Ensure consistent documentation structure.The JSX comment closure properly ends the commented section, but the large commented block may confuse users about available configuration options.
astro.config.mts (1)
293-312: LGTM! New TypeDoc sidebar entries follow established patterns.The additions of
@studiocms/md,@studiocms/html, and@withstudiocms/config-utilsto the TypeDoc sidebar are well-structured and consistent with existing entries. All entries are properly configured with appropriate labels, directory paths, and collapsed state.src/content/docs/en/utils/rendering.mdx (2)
12-12: LGTM! Proper import for the Aside component.The import statement correctly imports the
Asidecomponent from@astrojs/starlight/componentsfor use in the documentation.
18-21: Excellent addition of clarifying information.The aside block provides crucial information about renderer plugin requirements, which helps users understand the new modular architecture. The content is clear and references the appropriate plugins (
@studiocms/md,@studiocms/html).src/content/package-catalog/studiocms-md.json (1)
1-10: LGTM! Well-structured package catalog entry.The JSON metadata for
@studiocms/mdis properly structured with all required fields. The"released": falseflag correctly indicates this is preparation for an upcoming release, which aligns with the Beta.22 documentation objectives.ec.config.mjs (3)
4-4: LGTM! TypeScript import enables better type safety.Adding the TypeScript import allows the use of TypeScript enums instead of magic numbers in the configuration.
15-15: Good addition of new error codes.Adding error codes 2307 and 2379 to the recognized errors list will help with TypeScript error handling in the documentation examples.
18-21: Excellent improvement using TypeScript enums.Replacing magic numbers with TypeScript enum values (
ts.ModuleResolutionKind.Bundler,ts.ScriptTarget.ESNext, etc.) improves code readability and maintainability. The simplifiedlibarray is also appropriate.src/content/docs/en/package-catalog/studiocms-plugins/studiocms-md.mdx (1)
24-37: Installation step omits the-Dflag used elsewhereMost integration docs add plugins as dev-dependencies (
pnpm add -D …). Decide whether runtime or dev scope is intended and document it consistently across all plugin pages.src/content/docs/en/package-catalog/studiocms-plugins/studiocms-html.mdx (1)
24-37: Consistent config pathsThe code block header says
studiocms.config.mjsbut the import in line 29 usesdefineStudioCMSConfig(good) whereas earlier docs still showstudiocms.config.mjswith default export only. Make sure both plugin pages follow the same pattern.package.json (1)
38-45: Potential Vite/ Astro incompatibilityAstro 5 pins Vite 5.*, yet the override below forces
^6.3.4. Verify that Astro 5.12.6 works with Vite 6; otherwise local dev & build will break.src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-22.mdx (4)
1-17: LGTM! Well-structured frontmatter and imports.The frontmatter properly configures the upgrade guide with appropriate metadata, NEW badge, and correct ordering. The component imports align with the document structure.
19-30: Clear documentation of breaking changes with good migration guidance.The breaking changes are well-documented and provide users with clear understanding of what needs to be updated. The section effectively communicates the architectural shift toward modular rendering plugins.
31-38: LGTM! Comprehensive overview of new features.The new features section effectively highlights the improvements and architectural enhancements introduced in this release.
39-43: LGTM! Clear documentation of bug fixes.The bug fixes section concisely documents the key improvements and corrections made in this release.
typedoc.config.ts (5)
59-65: LGTM! New plugin declarations align with architectural changes.The addition of TypeDoc plugins for the new
@studiocms/md,@studiocms/html, and@withstudiocms/config-utilspackages is consistent with the modular plugin architecture introduced in beta.22.
255-277: LGTM! Package path updates follow scoped naming conventions.The updates from flat naming to scoped package names (e.g.,
@studiocms/devapps) improve consistency and follow standard npm scoped package conventions.Also applies to: 288-302
240-247: LGTM! Entry points reflect component registry refactoring.The addition of
src/componentRegistry/entry points aligns with the architectural changes documented in the upgrade guide, wherestudiocms:component-proxyis replaced by the new component registry system.
311-365: LGTM! Well-structured configurations for new plugins.The TypeDoc configurations for the new plugins follow established patterns and include comprehensive entry points. The structure is consistent with existing plugin configurations.
303-309: LGTM! Explicit entry points improve MDX plugin documentation.The addition of explicit entry points for the
@studiocms/mdxpackage ensures comprehensive documentation coverage for this plugin.
…ange subproject commit reference
See #150 Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com>
4 participants
TODO Before final merge (after release has been done):
docs/src/content/package-catalog/studiocms-html.json
Line 9 in 1664ef6
docs/src/content/package-catalog/studiocms-md.json
Line 9 in 1664ef6
docs/package.json
Lines 25 to 32 in 1664ef6
Summary by CodeRabbit
Summary by CodeRabbit
New Features
@studiocms/md(Markdown) and@studiocms/html(HTML).Bug Fixes
Documentation
Chores