Skip to content

Conversation

Kitenite
Copy link
Contributor

@Kitenite Kitenite commented Aug 13, 2025

Description

Related Issues

Type of Change

  • Bug fix
  • New feature
  • Documentation update
  • Release
  • Refactor
  • Other (please describe):

Testing

Screenshots (if applicable)

Additional Notes


Important

Update documentation links, add troubleshooting section, and make minor CSS and script adjustments.

  • Documentation:
    • Update links in CONTRIBUTING.md, README.md, and faq.mdx to point to new paths under /developers.
    • Add troubleshooting.mdx for common issues like Codesandbox preview and authentication problems.
    • Rename docs/content/docs/contributing/developers to docs/content/docs/developers.
  • CSS:
    • Update background gradient in global.css for light and dark modes.
    • Remove subnav hiding rule in global.css.
  • Scripts:
    • Update package.json scripts for database operations to use cd into specific directories.
  • Misc:
    • Remove unused import in layout.tsx.

This description was created by Ellipsis for bebb91a. You can customize this summary. It will automatically update as commits are pushed.

Summary by CodeRabbit

  • Documentation

    • Updated developer docs links to the new /developers paths across site and README/FAQ.
    • Added a Troubleshooting page covering preview mode, authentication version issues, and database schema sync steps.
    • Refreshed sitemap to reflect the new docs structure.
  • Style

    • Implemented theme-based background via a CSS variable.
    • Restored subnav visibility by default.
  • Chores

    • Updated root database scripts to run from package directories.
    • Added a database reset script.

Copy link

vercel bot commented Aug 13, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Project Deployment Preview Comments Updated (UTC)
docs Ready Preview Comment Aug 13, 2025 6:47pm
web 🔄 Building Preview Comment Aug 13, 2025 6:47pm

Copy link

supabase bot commented Aug 13, 2025

This pull request has been ignored for the connected project wowaemfasoptxrdjhilu because there are no changes detected in apps/backend/supabase directory. You can change this behaviour in Project Integrations Settings ↗︎.


Preview Branches by Supabase.
Learn more about Supabase Branching ↗︎.

Copy link

coderabbitai bot commented Aug 13, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

Documentation links were updated from /contributing/developers to /developers, a new Troubleshooting docs page was added, docs metadata and sitemap were updated, CSS introduced theme-based background variables and removed a subnav hide rule, a redundant stylesheet import was removed, and root package.json database scripts were adjusted with a new db:reset script.

Changes

Cohort / File(s) Summary
Top-level docs links
CONTRIBUTING.md, README.md
Updated URLs to new /developers paths; no logic changes.
Developers docs link updates
docs/content/docs/developers/index.mdx, docs/content/docs/developers/running-locally.mdx
Adjusted internal links from /contributing/developers/* to /developers/*; updated appendix, architecture, and contribute links.
New troubleshooting page
docs/content/docs/developers/troubleshooting.mdx
Added “Troubleshooting” with guidance on preview, auth, and DB schema drift; includes images and commands.
Docs homepage and FAQ
docs/content/docs/index.mdx, docs/content/docs/faq.mdx
Updated contributor-related card/link targets to /developers equivalents.
Docs metadata and sitemap
docs/content/docs/meta.json, docs/public/sitemap-0.xml
Replaced “contributing” with “developers” in meta; refreshed sitemap URLs and timestamps to new structure.
Docs app styling/layout
docs/src/app/global.css, docs/src/app/layout.tsx
Added CSS vars for themed background, applied to body; removed rule hiding subnav; removed external stylesheet import.
Root package scripts
package.json
Modified db scripts to run via cd packages/db; added db:reset running in apps/backend.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

I twitch my ears at links made new,
Hop—/developers—clean and true.
A map refreshed, the styles align,
Subnav peeks in morning shine.
Scripts now burrow where they should,
Troubles fixed—oh, docs feel good!
Thump-thump: release, as only bunnies could. 🥕


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4638a6b and bebb91a.

⛔ Files ignored due to path filters (1)
  • docs/public/images/delete-cookies.png is excluded by !**/*.png
📒 Files selected for processing (12)
  • CONTRIBUTING.md (1 hunks)
  • README.md (3 hunks)
  • docs/content/docs/developers/index.mdx (1 hunks)
  • docs/content/docs/developers/running-locally.mdx (2 hunks)
  • docs/content/docs/developers/troubleshooting.mdx (1 hunks)
  • docs/content/docs/faq.mdx (1 hunks)
  • docs/content/docs/index.mdx (1 hunks)
  • docs/content/docs/meta.json (1 hunks)
  • docs/public/sitemap-0.xml (1 hunks)
  • docs/src/app/global.css (2 hunks)
  • docs/src/app/layout.tsx (0 hunks)
  • package.json (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/docs-layout

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@Kitenite Kitenite merged commit ddf1615 into main Aug 13, 2025
5 of 7 checks passed
@Kitenite Kitenite deleted the fix/docs-layout branch August 13, 2025 18:48
Kitenite added a commit that referenced this pull request Aug 14, 2025
* update docs layout

* update docs styling

* add troubleshoot section
zongkelong pushed a commit to zongkelong/ulook that referenced this pull request Aug 15, 2025
* 'main' of https://github.com/onlook-dev/onlook: (41 commits)
  feat: fix delete project (onlook-dev#2683)
  feat: reduce search latency (onlook-dev#2682)
  feat: revamp projects ux (onlook-dev#2672)
  Upload fix (onlook-dev#2677)
  feat: using firecrawl to screenshot (onlook-dev#2665)
  fix: file upload build error (onlook-dev#2674)
  feat: new project frames (onlook-dev#2673)
  feat: self hosting docs (onlook-dev#2671)
  fix: docs layout + troubleshoot section (onlook-dev#2670)
  fix(template): suppress hydration mismatch
  Feat/editor improvements (onlook-dev#2601)
  fix: make message content selectable (onlook-dev#2664)
  bugs: transient stream error (onlook-dev#2663)
  feat: update migration files (onlook-dev#2659)
  Start from Blank + Import buttons on the home page (onlook-dev#2653)
  fix: snapshot type conflict and mastra can't view image (onlook-dev#2656)
  fix: typecheck snapshot (onlook-dev#2655)
  feat: clean up mastra branch (onlook-dev#2654)
  feat: mastra no storage (onlook-dev#2650)
  feat: update ai packages (onlook-dev#2648)
  ...
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.

1 participant