Skip to content

feat: public dir support, logo and content icon config#54

Merged
rsbh merged 2 commits intomainfrom
feat/public-dir-and-logo-support
May 8, 2026
Merged

feat: public dir support, logo and content icon config#54
rsbh merged 2 commits intomainfrom
feat/public-dir-and-logo-support

Conversation

@rsbh
Copy link
Copy Markdown
Member

@rsbh rsbh commented May 8, 2026

Summary

  • Serve static assets from project's public/ directory via Vite publicDir and Nitro publicAssets
  • Add logo config to basic example (default theme)
  • Add content dir icon support with file-based SVG in public/icons/
  • Switch basic example to default theme

Test plan

  • bun run dev:examples:basic — logo renders in sidebar header
  • Content icon renders next to "Docs" in sidebar top links
  • Static files from public/ dir accessible (e.g. /logo.svg, /icons/docs.svg)
  • Verify production build serves public assets correctly

🤖 Generated with Claude Code

rsbh and others added 2 commits May 8, 2026 13:18
Serve static assets from project's public/ directory via Vite publicDir
and Nitro publicAssets. Update basic example to use default theme with
logo configuration.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented May 8, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
chronicle Ready Ready Preview, Comment May 8, 2026 8:41am

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 8, 2026

Review Change Stack

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Summary by CodeRabbit

  • New Features

    • Logo configuration now supports separate light and dark variants for theme switching
    • Documentation navigation entries can now include custom icon fields
  • Updates

    • Example site configuration updated to use the default theme
    • Static assets integration enhanced for improved delivery

Walkthrough

This PR updates the Chronicle build system to properly serve public static assets through Vite and Nitro, then demonstrates the capability in the example configuration by adding logo and icon asset references alongside a theme name change from paper to default.

Changes

Static Asset Configuration and Example Integration

Layer / File(s) Summary
Build Asset Configuration
packages/chronicle/src/server/vite-config.ts
Vite's publicDir is set to <projectRoot>/public, and Nitro configuration adds publicAssets pointing to the same directory for static asset serving.
Example Configuration
examples/basic/chronicle.yaml
Example site configuration adds logo section with light and dark paths, enhances content.docs with an icon field, and changes theme.name from paper to default.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • rohanchkrabrty
  • rohilsurana
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and accurately summarizes the main changes: adding public directory support, logo configuration, and content icon configuration.
Description check ✅ Passed The description is directly related to the changeset, providing clear context about serving static assets, logo config, and icon support with a structured test plan.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/public-dir-and-logo-support

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.

@rsbh rsbh merged commit 40d7ea7 into main May 8, 2026
3 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants