📖 docs: Update README.md

[AquaWolf]

Description

Update the readme file

Related Issues

none

Type of Change

• [ ] Bug fix (non-breaking change)
• [ ] New feature (non-breaking change)
• [ ] Breaking change (fix or feature that changes existing functionality)
• [x] Documentation update
• [ ] Other (please describe):

Checklist

• [x] I have updated relevant documentation
• [x] My code follows the project's coding style
• [x] My changes generate no new warnings/errors

Notes for Reviewers

none

Screenshots/Demo

none

Additional Context

none

[cloudflare-workers-and-pages[bot]]

Deploying nestri with    Cloudflare Pages

Latest commit:	4e87357
Status:	✅  Deploy successful!
Preview URL:	https://90dc915f.nestri.pages.dev
Branch Preview URL:	https://feat-readme.nestri.pages.dev

View logs

[Christiangnuxyz]

Is it not a bit weird to mention that a Netris can run on Ubuntu in Readme but then in current documentation mention that Debian and Ubuntu are not supported?

[AquaWolf]

Yep should I also update the documentation?

[Christiangnuxyz]

Yes it think you should update the documentation before you change the Readme

[coderabbitai[bot]]

Walkthrough

This update restructures the Nestri documentation app and related deployment files. The docs site transitions to a new minimal Nuxt-based theme, with reworked configuration, content, and styling. Documentation is reorganized, with expanded guides for self-hosting and deployment, detailed CLI references, and improved home and introduction pages. Reverse proxy deployment examples using Caddy and Traefik are added, while legacy and internal documentation is removed.

Changes

Files/Paths	Change Summary
README.md	Simplified to minimal layout with logo, project title, and tagline; removed all detailed textual content and badges.
apps/docs/.eslintrc.cjs, apps/docs/renovate.json, apps/docs/sst-env.d.ts	Deleted ESLint config, Renovate config, and SST environment type declaration files.
apps/docs/.gitignore	Reorganized and expanded ignore rules with clearer categorization; added new patterns and removed some redundant entries.
apps/docs/.npmrc	Removed trailing newline character.
apps/docs/README.md	Added new README for shadcn-docs-nuxt starter template with setup, development, build, preview, and deployment instructions.
apps/docs/RELAY.md, apps/docs/content/3.nestri-relay/3.deploy-moq.md, apps/docs/content/3.nestri-relay/4.advanced-users.md, apps/docs/content/3.nestri-relay/5.moq-tester.md	Deleted detailed MoQ relay deployment, advanced self-hosting, and testing guides.
apps/docs/app.config.ts	Replaced old docus config with new shadcnDocs config featuring modular sections for site, theme, header, aside, main, footer, toc, and search.
apps/docs/assets/css/tailwind.css	Added new Tailwind CSS stylesheet with CSS variables for light/dark theming, base styles, and a custom step counter utility.
apps/docs/components/AppSocialIcons.vue, apps/docs/components/Logo.vue	Removed social icons and old logo components.
apps/docs/components/content/Contributors.vue	Improved dark mode support; replaced NuxtImg with standard <img> tags; updated badge styling for dark mode.
apps/docs/components/layout/Header/Logo.vue	Added new logo component supporting light/dark logos and optional title display, driven by configuration.
apps/docs/content/0.index.md, apps/docs/content/4.nestri-internal/*	Removed old home page and internal documentation content files.
apps/docs/content/index.md	Added new home page with hero section, announcement banner, call-to-action buttons, and contributors section.
apps/docs/content/1.introduction/, apps/docs/content/2.nestri-node/	Rewritten and expanded introduction, FAQ, node setup, CLI reference, and developer notes with improved clarity and technical detail.
apps/docs/content/3.nestri-relay/1.what-is-nestri-relay.md, apps/docs/content/3.nestri-relay/2.selfhosted-nestri-relay.md, apps/docs/content/3.nestri-relay/3.container-cli.md	Added new relay documentation including overview, self-hosting guidance with reverse proxy deployment examples (Caddy, Traefik), and CLI reference; removed legacy relay docs.
apps/docs/content/3.nestri-relay/_dir.yml, apps/docs/content/2.nestri-node/_dir.yml	Updated directory metadata: changed icons, added navigation redirects, and adjusted title formatting.
apps/docs/nuxt.config.ts	Switched theme from @nuxt-themes/docus to shadcn-docs-nuxt; removed modules and components auto-import; updated compatibility date.
apps/docs/package.json	Renamed project; switched from devDependencies to dependencies; updated dependencies to include nuxt, shadcn-docs-nuxt, vue, and vue-router; set "type": "module".
apps/docs/tailwind.config.js	Added new Tailwind CSS config enabling dark mode, custom colors, border radius, keyframes, animations, and plugin for UI animations.
apps/docs/tsconfig.json	Removed "ignoreConfigErrors": true; uncommented "extends": "./.nuxt/tsconfig.json"; added comment linking Nuxt TS docs.
apps/docs/tokens.config.ts	Deleted theme design tokens configuration file.
containers/Caddyfile	Added new Caddyfile for relay domain with WebSocket upgrade handling and TLS configuration.
containers/docker-compose.relay.caddy.yml	Added new Docker Compose file defining caddy reverse proxy and relay service with custom bridge network.
containers/docker-compose.relay.traefik.yml	Added new Docker Compose file defining traefik reverse proxy and relay service with external network, routing labels, and ACME TLS configuration.

Sequence Diagram(s)

sequenceDiagram
    participant UserBrowser
    participant ReverseProxy (Caddy/Traefik)
    participant NestriRelay
    participant NestriNode

    UserBrowser->>ReverseProxy: Connect via WebRTC (wss://relay.example.com)
    ReverseProxy->>NestriRelay: Forward WebSocket/WebRTC traffic
    NestriRelay->>NestriNode: Request/forward audio-video stream
    NestriNode-->>NestriRelay: Send encoded stream
    NestriRelay-->>UserBrowser: Deliver low-latency stream

Poem

In docs anew, the rabbits hop,
With Tailwind breeze and Nuxt on top.
Relays now behind a proxy wall,
Caddy and Traefik answering the call.
Home is fresh, the guides are clear—
Cloud gaming’s future is drawing near!
🐇✨

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Explain this complex logic.
  • 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. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• 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 src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

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

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

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

Documentation and Community

• 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.

[wanjohiryan]

@coderabbitai can you create an issue where i flesh out the README file. Thanks!

[wanjohiryan]

Merging this as is

[wanjohiryan]

@coderabbitai resolve all

[coderabbitai[bot]]

[!TIP] For best results, initiate chat on the files or code changes.

@wanjohiryan I've reviewed the comment chain and there aren't any specific CodeRabbit review comments that require resolution in this PR. The main discussion was about the Ubuntu support inconsistency between the README and documentation that @Christiangnuxyz pointed out.

The key points from the discussion were:

• The README mentions Nestri can run on Ubuntu
• The current documentation states Debian and Ubuntu are not supported
• This inconsistency should ideally be addressed in the documentation before updating the README

Since you mentioned you're merging this as-is, these discussion points are noted but don't require immediate action in this PR.

I notice you had earlier requested me to create an issue to flesh out the README file. Would you still like me to create that GitHub issue as a follow-up action?

🐰✨ (\ /) ( ..) o(")(")

[coderabbitai[bot]]

[!TIP] For best results, initiate chat on the files or code changes.

🧩 Analysis chain

@wanjohiryan I'll create a GitHub issue to track the README improvement work!

---

🏁 Script executed:

#!/bin/bash
# Create a GitHub issue for fleshing out the README file
gh issue create \
  --title "📖 Enhance README.md with comprehensive project information" \
  --body "## Background

The README.md was simplified in PR #189 to a minimal layout with just the logo, title, and tagline. While this creates a clean visual presentation, it removes important project information that users need to understand Nestri.

## Description

We need to flesh out the README.md to provide comprehensive information about the project while maintaining a clean and professional appearance.

## Tasks

- [ ] Add project description and overview
- [ ] Include key features and capabilities
- [ ] Add installation/getting started instructions
- [ ] Include links to detailed documentation
- [ ] Add contribution guidelines
- [ ] Include license information
- [ ] Add badges for build status, version, etc.
- [ ] Ensure consistency with the documentation (address the Ubuntu/Debian support discrepancy mentioned in the PR discussion)
- [ ] Add screenshots or demo links if available
- [ ] Include community/support links

## Context

- **Related PR**: https://github.com/nestrilabs/nestri/pull/189
- **Requested by**: @wanjohiryan
- **Comment**: https://github.com/nestrilabs/nestri/pull/189#issuecomment-$(gh pr view 189 --json comments --jq '.comments[-1].id')

## Acceptance Criteria

- README provides clear understanding of what Nestri is and does
- Installation/setup instructions are clear and accurate
- Documentation links are comprehensive and up-to-date
- Information is consistent with the project documentation
- Maintains visual appeal with proper formatting and structure" \
  --assignee wanjohiryan

Length of output: 1684

---

Perfect! I've successfully created GitHub issue #296 to track the README enhancement work.

Issue created: https://github.com/nestrilabs/nestri/issues/296

The issue includes:

• ✅ Background context about the current simplified README
• ✅ Comprehensive task checklist covering all aspects of a good README
• ✅ Reference to the Ubuntu/Debian documentation consistency issue mentioned earlier in this PR
• ✅ Clear acceptance criteria
• ✅ Backlinks to this PR and your comment
• ✅ Assigned to you (@wanjohiryan)

The issue provides a solid roadmap for creating a comprehensive README that balances informativeness with visual appeal while ensuring consistency with your documentation.

    (\   /)
   ( ._. )
  o_(")(")
   Planning ahead like a good rabbit! 🐰✨

[wanjohiryan]

@coderabbitai resolve

[coderabbitai[bot]]

✅ Actions performed

Comments resolved.