Docs: clarify run/build and RTE migration#490
Open
gavinfaux wants to merge 2 commits into
Open
Conversation
- add a tip that test site target framework selects Umbraco version (net9.0 → v16, net10.0 → v17) - clarify that `pnpm run build` runs both TypeScript and Vite (regenerating theme and editor assets) - simplify run-from-source guidance - correct the rich-text-editor migration wording to state migration occurs only if TinyMCE is NOT registered.
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates project documentation to clarify Umbraco 16/17 upgrade behavior for the Rich Text Editor migration and to improve developer build/run guidance.
Changes:
- Clarifies when Articulate migrates
Umbraco.RichTextto TipTap based on TinyMCE UI registration. - Simplifies “build from source” run instructions by describing target-framework selection.
- Expands
DEVELOP.mdnotes about framework selection and whatpnpm run builddoes.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| umbraco-marketplace-readme.md | Updates marketplace-facing upgrade note for Rich Text Editor migration behavior. |
| README.md | Aligns public README instructions and upgrade note with the clarified migration behavior and new run guidance. |
| DEVELOP.md | Adds developer tips for choosing Umbraco version via TFM and clarifies the scope of pnpm run build. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Upgrade note for rich text editor compatibility | ||
|
|
||
| On Umbraco 16/17, Articulate will migrate the built-in `Umbraco.RichText` property editor to `Umb.PropertyEditorUi.TipTap` during package upgrade only if the TinyMCE editor UI is actually registered. | ||
| On Umbraco 16/17, Articulate will migrate the built-in `Umbraco.RichText` property editor to `Umb.PropertyEditorUi.TipTap` during package upgrade only if the TinyMCE editor UI is not registered. |
|
|
||
| - Install `Articulate` from NuGet (`dotnet add package Articulate`). The package includes the backoffice extension and static assets; no extra package references or manual copies required. | ||
| - When building from source, run the test site `dotnet run -f net9.0 --project src/Articulate.Tests.Website/Articulate.Tests.Website.csproj` (or `-f net10.0` for Umbraco 17) and sign into the Umbraco Back Office to finish setup. | ||
| - When building from source, run the test site with `-f net9.0` for Umbraco 16 or `-f net10.0` for Umbraco 17, then sign into the Umbraco Back Office to finish setup. |
| 5. Start `Articulate.Tests.Website` and complete the Umbraco installer. | ||
| 6. The Articulate package migrations will run and install the required schema and content items. | ||
|
|
||
| Tip: The test site's target framework selects the Umbraco version: `net9.0` runs Umbraco 16, and `net10.0` runs Umbraco 17. Use `net10.0` only when you specifically want the v17 path. |
| pnpm run generate:api | ||
| ``` | ||
|
|
||
| `pnpm run build` runs `tsc && vite build`; the Vite sidecar also regenerates the built-in theme `assets/dist` bundles and the Markdown editor assets, not just the Back Office client. |
Greptile SummaryThis is a documentation-only PR that corrects and clarifies three aspects of the Articulate developer docs across
Confidence Score: 5/5Documentation-only changes with no runtime code affected — safe to merge. All three files contain only markdown prose changes. The RTE migration correction reverses the condition ("is actually registered" → "is not registered"), which is consistent with the adjacent bullet stating that TinyMCE.Umbraco must be installed to retain TinyMCE — confirming the new wording matches the intended behaviour. No code, config, or schema is touched. No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Package upgrade runs] --> B{Is TinyMCE editor UI registered?}
B -- Yes --> C[Skip migration\nKeep Umbraco.RichText as-is]
B -- No --> D[Migrate Umbraco.RichText\nto Umb.PropertyEditorUi.TipTap]
D --> E[Umbraco records migration step as complete]
C --> F[User must have TinyMCE.Umbraco installed\nto retain TinyMCE going forward]
Reviews (2): Last reviewed commit: "Merge branch 'Shazwazza:develop' into fi..." | Re-trigger Greptile |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
pnpm run buildruns both TypeScript and Vite (regenerating theme and editor assets)