update settings and documentation for beta 26#162
Conversation
✅ Deploy Preview for studiocms-dev-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughUpdates include a VS Code spell list entry, removal/addition of MDX frontmatter badges and a new upgrade guide, package dependency bumps, a studiocms submodule pointer update, and a reworked TypeDoc entryPoints list. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 💡 Knowledge Base configuration:
You can enable these sources in your CodeRabbit configuration. ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (1)
⏰ 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. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
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
|
Adammatthiesen
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (8)
.vscode/settings.json (1)
10-10: Consider adding lowercase alias to avoid case-sensitivity misses.cSpell treats mixed-case entries as case-sensitive; if "iconify" appears in package names/URLs/code, it may still flag. Add the lowercase variant too.
Apply this diff:
"genpkey", "Iconify", + "iconify", "inox",studiocms (1)
1-1: Consider referencing a release tag or annotating the PR with the corresponding release.If this SHA corresponds to beta.26, linking the tag or noting the release in the PR description helps traceability and bisects. Alternatively, track the submodule to a release branch/tag for easier maintenance.
src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-26.mdx (4)
13-15: Remove unused imports or put Aside to use.
ReadMoreandAsideare imported but unused. Either remove them or add a callout that actually usesAside.Option A — remove unused imports:
-import ReadMore from '~/components/ReadMore.astro' import QuickUpdate from '~/components/QuickUpdate.astro' -import { Aside } from '@astrojs/starlight/components'Option B — keep
Asideand add a DB backup callout (recommended for an upgrade guide):<QuickUpdate /> ## Breaking Changes @@ -- Updated Astro DB Table schema (Users will be required to run `astro db push --remote` to update their table schema) +- Updated Astro DB table schema (Run `astro db push --remote` to apply schema changes) +<Aside type="caution" title="Back up your database"> +Before running <code>astro db push</code> (local or with <code>--remote</code>), back up your DB. Schema changes are destructive if they drop or alter columns. +</Aside>
21-24: Grammar, casing, and clarity nits in “Breaking Changes.”Light edits for consistency and readability.
-- Updated Astro DB Table schema (Users will be required to run `astro db push --remote` to update their table schema) - - Implements new DB table for dynamic config storage in unified table. - - Updated AstroDB table config to utilize enums for permissions. -- Remove deprecated locals from middleware in favor of a joined StudioCMS locals object. +- Updated Astro DB table schema (Run `astro db push --remote` to apply schema changes). + - Implements a new unified DB table for dynamic config storage. + - Updated Astro DB table config to use enums for permissions. +- Removed deprecated locals from middleware in favor of a unified StudioCMS locals object.
25-33: Fix “Astro.Locals” casing and tense; tighten phrasing.Use
Astro.locals(lowercase “l”) and keep past tense.- - Removed top-level Astro.Locals keys: + - Removed top-level Astro.locals keys: @@ - - New location: - - Access these under `Astro.locals.StudioCMS`. + - New location: access under `Astro.locals.StudioCMS`. @@ - - Renames: + - Renamed:
54-59: Tense and specificity in Features/Bug fixes (minor copy edits).Keep past tense and tighten wording.
- - Update to `@studiocms/ui` 1.0 beta. + - Updated to `@studiocms/ui` 1.0 beta. @@ -- Adjust SDK page lookup to return undefined when a page is not found, eliminating noisy Astro errors in development. -- Fix form data conversion on first time setup. +- Adjusted SDK page lookup to return `undefined` when a page is not found, reducing noisy Astro errors in development. +- Fixed form-data conversion on first-time setup.If downstream code previously assumed a thrown error or non-undefined return, please confirm this behavior change is non-breaking for your users and reflected in the API docs.
typedoc.config.ts (2)
168-168: New utility in docs surface: stripIconify.ts.Looks fine; just confirm it’s intentionally part of the public doc surface and not an internal-only helper.
173-175: Potential duplication: documenting both auth/index.ts and auth/core.ts.If
auth/index.tsre-exports fromauth/core.ts, listing both can create duplicate symbols/pages in TypeDoc. Prefer the aggregator entry point only.Proposed change (if index re-exports core):
- getFilePathToPackage('studiocms', 'src/virtuals/auth/index.ts'), - getFilePathToPackage('studiocms', 'src/virtuals/auth/core.ts'), + getFilePathToPackage('studiocms', 'src/virtuals/auth/index.ts'),
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (6)
.vscode/settings.json(1 hunks)src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-25.mdx(0 hunks)src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-26.mdx(1 hunks)src/content/docs/en/how-it-works/effect.mdx(0 hunks)studiocms(1 hunks)typedoc.config.ts(3 hunks)
💤 Files with no reviewable changes (2)
- src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-25.mdx
- src/content/docs/en/how-it-works/effect.mdx
🧰 Additional context used
🪛 LanguageTool
src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-26.mdx
[grammar] 13-/components/Qu...13: There might be a mistake here./components/ReadMore.astro' import QuickUpdate from '
Context: ...dMore from '
(QB_NEW_EN)
[grammar] ~14-14: There might be a mistake here./components/QuickUpdate.astro' import { Aside } from '@astrojs/starligh...
Context: ...te from '
(QB_NEW_EN)
[grammar] ~22-~22: There might be a mistake here.
Context: ...dynamic config storage in unified table. - Updated AstroDB table config to utilize ...
(QB_NEW_EN)
[grammar] ~25-~25: There might be a mistake here.
Context: ... - Removed top-level Astro.Locals keys: - SCMSGenerator, SCMSUiGenerator, latestVersion, `s...
(QB_NEW_EN)
[grammar] ~26-~26: There might be a mistake here.
Context: ...tVersion, siteConfig, defaultLang, routeMap -userSessionData, emailVerificationEnabled, userPermi...
(QB_NEW_EN)
[grammar] ~28-~28: There might be a mistake here.
Context: ...el -wysiwygCsrfToken` (renamed) - New location: - Access these under...
(QB_NEW_EN)
[grammar] ~29-~29: There might be a mistake here.
Context: ...gCsrfToken(renamed) - New location: - Access these underAstro.locals.StudioC...
(QB_NEW_EN)
[grammar] ~32-~32: There might be a mistake here.
Context: ...n→editorCSRFToken` (under StudioCMS) - Migration examples: - Before: ...
(QB_NEW_EN)
[grammar] ~33-~33: There might be a mistake here.
Context: ...nder StudioCMS) - Migration examples: - Before: ```ts const { ...
(QB_NEW_EN)
🔇 Additional comments (7)
.vscode/settings.json (1)
10-10: LGTM: Added "Iconify" to cSpell dictionary.This prevents false positives in docs/editor. No issues with JSON structure or ordering.
studiocms (1)
1-1: Submodule bump verified..gitmodulescorrectly points to https://github.com/withstudiocms/studiocms.git and commit d77a8c16c97b91343f1c03b2fd9dd2fca0252647 exists upstream. Ensure CI runsgit submodule sync --recursive && git submodule update --init --recursivebefore merging.src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-26.mdx (2)
36-41: Migration example (locals) looks good.Clear before/after snippet; matches the bullet list above.
1-11: Unify version string in description
Change the description to “Upgrade StudioCMS to 0.1.0-beta.26”. Thesidebar.badge.variant: successsetting is valid (supported variants: note, danger, success, caution, tip, default).typedoc.config.ts (3)
211-211: Add SDK config module to docs surface.Good addition; aligns with the SDK reorg.
180-181: Oldvirtuals/i18n/index.tsreference removed
Search forvirtuals/i18n/index.tsintypedoc.config.tsreturned no occurrences; the old index entry is fully removed.
130-130: No stale changelog references remain — verified thattypedoc.config.tscontains no references tohandlers/changelog/index.tsorhandlers/changelog/changelogLoader.ts.
* i18n(fr): update docs for beta 26 See #162 * remove a frontmatter property * fix casing
3 participants
Description
TODO BEFORE MERGE
Summary by CodeRabbit