Skip to content

chore(docs): cleanup documentation#285

Merged
luxass merged 3 commits intomainfrom
cleanup-docs
Oct 3, 2025
Merged

chore(docs): cleanup documentation#285
luxass merged 3 commits intomainfrom
cleanup-docs

Conversation

@luxass
Copy link
Copy Markdown
Member

@luxass luxass commented Oct 3, 2025

🔗 Linked issue

resolves #284

📚 Description

Summary by CodeRabbit

  • Documentation

    • Rebranded docs from Docus to UCD.js across titles, copy, icons, and links.
    • Updated Getting Started: new Introduction and Installation with current commands, examples, and warnings.
    • Revamped homepage: SEO metadata, hero content, CTA, and “Core Features” focused on Unicode tooling.
    • Removed legacy sections: Project Structure, Studio, Migration, and Essentials (Markdown, Code Blocks, Components, Images/Embeds), along with related navigation entries.
  • Chores

    • Deployment workflow now falls back to the Docs deployment URL if API/Web URLs are unavailable.

luxass added 2 commits October 3, 2025 06:19
* 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.
@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Oct 3, 2025

⚠️ No Changeset found

Latest commit: ef2cebd

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Oct 3, 2025

Walkthrough

Adds 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

Cohort / File(s) Summary
CI Workflow URL selection
\.github/workflows/deploy-app.yml
Extends DEPLOYMENT_URL extraction to try deploy-api, then deploy-web, then deploy-docs step outputs; no other control changes.
Docs rebrand and content updates
apps/docs/content/1.getting-started/2.introduction.md, apps/docs/content/1.getting-started/3.installation.md, apps/docs/content/index.md
Rebrands Docus/Nuxt references to UCD.js; updates installation and intro guidance; revises homepage SEO, hero, links, and feature descriptions.
Docs removals (legacy content)
apps/docs/content/1.getting-started/4.project-structure.md, .../5.studio.md, .../6.migration.md, apps/docs/content/2.essentials/.navigation.yml, apps/docs/content/2.essentials/1.markdown-syntax.md, .../2.code-blocks.md, .../3.components.md, .../4.images-embeds.md
Deletes project structure, Studio, migration, Essentials navigation, and multiple Essentials pages (markdown syntax, code blocks, components, images/embeds).
Docs ESLint config formatting
apps/docs/eslint.config.mjs
Minor stylistic changes (quote style, trailing semicolon); export unchanged.
Nuxt configuration expansion
apps/docs/nuxt.config.ts
Adds compatibilityDate, eslint config (stylistic and devtools), and llms metadata; preserves modules with minor formatting change.

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
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

Suggested labels

🚨 ci

Poem

I hop through docs, a tidy sweep,
Old trails gone, new carrots deep.
UCD.js shines, a Unicode feast—
From index hills to install east.
CI finds the path it seeks,
API, Web, or Docs—no leaks.
Thump-thump! Deploy complete. 🥕

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Out of Scope Changes Check ⚠️ Warning The PR includes changes to the deployment workflow, ESLint configuration, and Nuxt configuration which are not related to removing or replacing placeholder documentation as specified by issue #284. Move non-documentation modifications such as workflow, linting, and Nuxt config changes into a separate PR targeting their appropriate issues to keep this submission focused on cleaning up documentation.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit's high-level summary is enabled.
Title Check ✅ Passed The title chore(docs): cleanup documentation concisely and accurately reflects the PR’s primary purpose of removing and rebranding documentation content.
Linked Issues Check ✅ Passed The PR removes the bootstrapped placeholder documentation and replaces key sections with UCD.js-specific content, satisfying the requirement to clean the docs app template content under issue #284.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch cleanup-docs

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Oct 3, 2025

🌏 Preview Deployments

Application Status Preview URL
API ✅ Deployed View Preview
Website ✅ Deployed View Preview
Documentation ✅ Deployed View Preview

Built from commit: ef2cebd4de0e1511cbe48a4cac48e3db263bfc6d


🤖 This comment will be updated automatically when you push new commits to this PR.

@codecov
Copy link
Copy Markdown

codecov bot commented Oct 3, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@luxass luxass marked this pull request as ready for review October 3, 2025 04:47
Copilot AI review requested due to automatic review settings October 3, 2025 04:47
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

@github-actions github-actions bot added the 🚨 ci Changes related to our CI pipelines label Oct 3, 2025
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5309035 and ef2cebd.

📒 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)

@luxass luxass merged commit c51ffca into main Oct 3, 2025
26 checks passed
@luxass luxass deleted the cleanup-docs branch October 3, 2025 04:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🚨 ci Changes related to our CI pipelines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

clean docs app for template files

2 participants