Conversation
* Updated the import statement in `eslint.config.mjs` to use consistent double quotes. * Added missing commas in `nuxt.config.ts` for proper syntax. * Organized the `eslint` configuration for better readability.
…CD.js project - Deleted project structure, studio, and migration documentation files. - Removed essentials navigation and markdown syntax documentation. - Cleaned up code blocks and components documentation. - Updated images and embeds documentation. - Revamped index page to reflect UCD.js branding and features.
|
WalkthroughAdds a docs deployment URL fallback to the CI deploy workflow. Rebrands and restructures docs from Docus/Nuxt to UCD.js, including homepage and getting-started pages. Removes multiple legacy docs sections. Updates docs ESLint formatting. Expands Nuxt config with compatibilityDate, eslint, and llms settings. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant CI as GitHub Actions
participant API as deploy-api step
participant WEB as deploy-web step
participant DOCS as deploy-docs step
participant EX as extract step
CI->>API: Run deploy API
Note over API: outputs.deployment-url (optional)
CI->>WEB: Run deploy Web
Note over WEB: outputs.deployment-url (optional)
CI->>DOCS: Run deploy Docs
Note over DOCS: outputs.deployment-url (optional)
CI->>EX: Extract deployment result
alt URL available from API
EX->>EX: Use API deployment-url
else URL available from WEB
EX->>EX: Use WEB deployment-url
else URL available from DOCS
EX->>EX: Use DOCS deployment-url
else
EX->>EX: No URL set
end
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Suggested labels
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ 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. Comment |
🌏 Preview Deployments
Built from commit: 🤖 This comment will be updated automatically when you push new commits to this PR. |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Pull Request Overview
Documentation cleanup and rebranding from Docus-focused content to UCD.js, plus minor configuration adjustments. Key changes include removing legacy Docus documentation, updating introductory and installation guides for UCD.js, and extending deployment logic to include docs deployment URL.
- Rebranded documentation pages to UCD.js and removed obsolete Docus-specific sections
- Added configuration updates in Nuxt and CI to support new docs/deployment needs
- Simplified and refocused homepage and installation flows toward Unicode tooling
Reviewed Changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| apps/docs/nuxt.config.ts | Added eslint stylistic config, Cloudflare compatibility date, custom llms block, and formatting adjustments |
| apps/docs/eslint.config.mjs | Style normalization (quotes/semicolons) |
| apps/docs/content/index.md | Reworked landing page content to reflect UCD.js focus |
| apps/docs/content/1.getting-started/2.introduction.md | Replaced Docus intro with UCD.js overview and feature set |
| apps/docs/content/1.getting-started/3.installation.md | Rewrote installation guide for UCD.js packages and CLI |
| Multiple removed content files under getting-started and essentials | Removed Docus-specific feature documentation no longer relevant |
| .github/workflows/deploy-app.yml | Added docs deployment URL fallback to DEPLOYMENT_URL resolution |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (14)
.github/workflows/deploy-app.yml(1 hunks)apps/docs/content/1.getting-started/2.introduction.md(1 hunks)apps/docs/content/1.getting-started/3.installation.md(1 hunks)apps/docs/content/1.getting-started/4.project-structure.md(0 hunks)apps/docs/content/1.getting-started/5.studio.md(0 hunks)apps/docs/content/1.getting-started/6.migration.md(0 hunks)apps/docs/content/2.essentials/.navigation.yml(0 hunks)apps/docs/content/2.essentials/1.markdown-syntax.md(0 hunks)apps/docs/content/2.essentials/2.code-blocks.md(0 hunks)apps/docs/content/2.essentials/3.components.md(0 hunks)apps/docs/content/2.essentials/4.images-embeds.md(0 hunks)apps/docs/content/index.md(3 hunks)apps/docs/eslint.config.mjs(1 hunks)apps/docs/nuxt.config.ts(1 hunks)
💤 Files with no reviewable changes (8)
- apps/docs/content/1.getting-started/6.migration.md
- apps/docs/content/1.getting-started/4.project-structure.md
- apps/docs/content/2.essentials/.navigation.yml
- apps/docs/content/1.getting-started/5.studio.md
- apps/docs/content/2.essentials/1.markdown-syntax.md
- apps/docs/content/2.essentials/3.components.md
- apps/docs/content/2.essentials/2.code-blocks.md
- apps/docs/content/2.essentials/4.images-embeds.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
apps/docs/content/1.getting-started/2.introduction.md
22-22: Heading style
Expected: atx; Actual: setext
(MD003, heading-style)
22-22: Headings must start at the beginning of the line
(MD023, heading-start-left)
30-30: Heading style
Expected: atx; Actual: setext
(MD003, heading-style)
30-30: Headings must start at the beginning of the line
(MD023, heading-start-left)
apps/docs/content/index.md
8-8: No space after hash on atx style heading
(MD018, no-missing-space-atx)
11-11: No space after hash on atx style heading
(MD018, no-missing-space-atx)
16-16: No space after hash on atx style heading
(MD018, no-missing-space-atx)
19-19: Headings must start at the beginning of the line
(MD023, heading-start-left)
32-32: Bare URL used
(MD034, no-bare-urls)
43-43: No space after hash on atx style heading
(MD018, no-missing-space-atx)
46-46: Headings must start at the beginning of the line
(MD023, heading-start-left)
57-57: Headings must start at the beginning of the line
(MD023, heading-start-left)
68-68: Headings must start at the beginning of the line
(MD023, heading-start-left)
79-79: Headings must start at the beginning of the line
(MD023, heading-start-left)
90-90: Headings must start at the beginning of the line
(MD023, heading-start-left)
101-101: Headings must start at the beginning of the line
(MD023, heading-start-left)
⏰ 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). (6)
- GitHub Check: test (macos-latest)
- GitHub Check: test (ubuntu-latest)
- GitHub Check: test (windows-latest)
- GitHub Check: lint
- GitHub Check: typecheck
- GitHub Check: deploy apps / deploy app (docs)
🔗 Linked issue
resolves #284
📚 Description
Summary by CodeRabbit
Documentation
Chores