Conversation
Deploying nestri with
|
| Latest commit: |
4e87357
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://90dc915f.nestri.pages.dev |
| Branch Preview URL: | https://feat-readme.nestri.pages.dev |
|
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? |
|
Yep should I also update the documentation? |
|
Yes it think you should update the documentation before you change the Readme |
victorpahuus
left a comment
victorpahuus
left a comment
There was a problem hiding this comment.
Seems good to me! Great changes :)
WalkthroughThis 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
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
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 9
🔭 Outside diff range comments (1)
apps/docs/components/content/Contributors.vue (1)
25-34: Remove invalid<img>attributesStandard HTML
<img>does not supportproviderordensitiesprops, andheight/widthattributes expect numeric values. Use CSS classes for sizing instead.Apply this diff:
- <img - :src="contributor.avatar_url" - provider="ipx" - densities="x1 x2" - height="80px" - width="80px" - :alt="contributor.login" - loading="lazy" - class="rounded-xl w-full h-full transition lg:hover:scale-110" - /> + <img + :src="contributor.avatar_url" + :alt="contributor.login" + loading="lazy" + class="rounded-xl w-20 h-20 transition lg:hover:scale-110" + />
🧹 Nitpick comments (32)
containers/docker-compose.relay.traefik.yml (1)
52-52: Add newline at end of fileEnsure a trailing newline after the last line to satisfy POSIX conventions and resolve YAML lint warnings.
apps/docs/content/3.nestri-relay/_dir.yml (1)
1-3: Add newline at end of file.
YAML files should end with a newline to satisfy common linting rules.apps/docs/content/2.nestri-node/_dir.yml (1)
1-3: Add newline at end of file.
To comply with YAML lint rules, ensure the file ends with a newline character.apps/docs/content/3.nestri-relay/1.what-is-nestri-relay.md (1)
8-9: Add newline at end of file.
Markdown files should end with a newline to satisfy POSIX and tooling expectations.apps/docs/README.md (1)
49-49: Use “Check out” instead of “Checkout”.
“Checkout” is a noun; in this context use the verb phrase “Check out” for clarity.apps/docs/content/1.introduction/_dir.yml (1)
3-3: Ensure newline at EOFAdd a newline at the end of the file to satisfy YAML lint (
new-line-at-end-of-file).@@ _dir.yml icon: lucide:rocket +apps/docs/content/2.nestri-node/6.node-faq.md (2)
1-5: Consistent frontmatter formattingConsider standardizing quoting in frontmatter (e.g., use double quotes for string values) to align with other docs files.
@@ 6.node-faq.md -title: Node FAQ +title: "Node FAQ" description: This FAQ is made to address common questions about Nestri Node, the container which runs your games. Whether you're curious about compatibility, setup, or performance, you'll find answers to help you get started. -icon: 'lucide:info' +icon: "lucide:info"
11-11: Optional: Reintroduce performance caveatYou removed the warning about virtualization overhead. Consider noting potential latency or performance impacts in virtualized environments.
## Can I run Nestri Node in a virtualized environment like Proxmox? Yes, you can run Nestri Node in a virtualized environment, provided you passthrough your GPU to the virtual machine. Note that virtualization may introduce additional latency and overhead.apps/docs/content/2.nestri-node/1.what-is-nestri-node.md (2)
3-4: Fix grammar in front-matter description“how does it powers the Nestri eco-system” is ungrammatical and “eco-system” is usually written “ecosystem”.
-description: What is Nestri Node and how does it powers the Nestri eco-system and your self-hosted cloud gaming experience. +description: What Nestri Node is and how it powers the Nestri ecosystem and your self-hosted cloud-gaming experience.
7-7: Use the correct article before ‘NVIDIA’The sentence should read “an NVIDIA” (vowel sound). Also add commas for readability.
-It runs on most Linux-based systems and requires a NVIDIA, AMD or Intel graphics card. +It runs on most Linux-based systems and requires an NVIDIA, AMD, or Intel graphics card.apps/docs/content/3.nestri-relay/3.container-cli.md (1)
15-20: Duplicate default port values may confuse usersBoth
--endpointPortand--webrtcUDPMuxdefault to 8088. If that is intentional, add a clarification note; otherwise adjust one of the defaults.apps/docs/content/2.nestri-node/7.developer-notes.md (2)
8-13: Improve heading & wordingMinor wording tweaks improve clarity and consistency.
-### Construct The Nestri Runner Docker Image -Checkout your branch with the latest version of nestri and build the image `<your-nestri-image>` within git root folder: +### Build the Nestri Runner Docker image +Check out the branch containing the latest Nestri source and build the `<your-nestri-image>` image from the repository root:
20-24: Insert missing comma for readability-For most games that are not DRM free you need a launcher. In this case use the umu launcher: +For most DRM-protected games, you need a launcher. In this case, use the **umu-launcher**:containers/docker-compose.relay.caddy.yml (2)
3-3: Pin Caddy image version
Usingcaddy:latestmay introduce breaking changes. Pin to a specific version (e.g.,caddy:2.6.5) to ensure reproducible deployments.
33-33: Add trailing newline
YAML files should end with a newline character to satisfy linters and some parsers.apps/docs/content/2.nestri-node/3.getting-started.md (4)
22-24: Reconsider directory permissions
Grantingchmod 777on~/nestriis overly permissive. For better security, usechmod 700or map container UID/GID appropriately.
29-29: Fix article usage
Change “an unique name” to “a unique name” for correct English grammar.
13-15: Simplify code fence annotations
The syntaxbash [pull image command]may not be supported by all markdown parsers. Use standard ```bash and move the descriptor below the block.
31-33: Improve command readability
These longpodman runcommands could be split across multiple lines with backslashes or indented flags to enhance clarity.apps/docs/content/2.nestri-node/5.container-cli.md (2)
7-7: Add terminal punctuation
The introductory sentence ends without a period. Append one for consistency:... effectively.
9-36: Consistent article usage in table descriptions
Many parameter descriptions lack determiners (e.g., “GPU index to use” → “The GPU index to use”). Consider revising entries for uniform style.apps/docs/content/2.nestri-node/2.prerequisite.md (1)
24-26: Ensure proper list spacing
Add a blank line before and after each::list{type="primary"}block to guarantee correct rendering in the static site generator.apps/docs/content/1.introduction/2.faq.md (2)
32-32: Remove unnecessary comma
The comma in “Keep in mind that, because Nestri has to use…” is unnecessary. Use “Keep in mind that because Nestri has to use…” for a smoother flow.
35-35: Replace verbose phrase
Consider “Currently” instead of “At the moment” for conciseness:Currently, we don’t have a dedicated app.apps/docs/content/1.introduction/1.what-is-nestri.md (2)
23-25: Missing article in descriptive sentence
"splits single incoming stream to multiple potential players"is missing the article a before single.- ...that splits single incoming stream to multiple potential players... + ...that splits a single incoming stream to multiple potential players...
17-19: Plural-possessive typo
"major vendor's GPUs"should be plural-possessive (vendors') to match the three vendors listed.- ...most Linux-based systems and major vendor's GPUs (Intel, AMD, NVIDIA). + ...most Linux-based systems and major GPU vendors' GPUs (Intel, AMD, NVIDIA).apps/docs/assets/css/tailwind.css (1)
31-34: Inconsistent spacing after colon in CSS custom-property declarationsMost variables include a space after
:, but a handful don’t (--border:214.3…). Consistent spacing improves readability and avoids noisy diffs later on.- --border:214.3 31.8% 91.4%; - --input:214.3 31.8% 91.4%; - --ring:221.2 83.2% 53.3%; + --border: 214.3 31.8% 91.4%; + --input: 214.3 31.8% 91.4%; + --ring: 221.2 83.2% 53.3%;Also applies to: 62-65
apps/docs/app.config.ts (2)
4-6: Update description – still references the template instead of Nestri
'Beautifully designed Nuxt Content template built with shadcn-vue…'looks copy-pasted from the starter template and doesn’t describe Nestri Docs.- description: 'Beautifully designed Nuxt Content template built with shadcn-vue. Customizable. Compatible. Open Source.', + description: 'Official Nestri documentation – architecture, deployment and API reference.',
20-30: Navigation duplicationThe two GitHub links (star + plain logo) both point to the same repo. Consider removing one to reduce clutter.
README.md (1)
84-90: Unused reference & markdown-lint warnings
[vmaf-cuda-link]is defined but never used. Removing it (and any other unused reference definitions) will silence MD053 and keep the README tidy.apps/docs/content/3.nestri-relay/2.selfhosted-nestri-relay.md (2)
44-47: Incorrect article
"an Reverse Proxy"→"a Reverse Proxy"-## Self-hosted Nestri Relay with an Reverse Proxy +## Self-hosted Nestri Relay with a Reverse Proxy
99-100: Verb/noun confusion“setup the Caddyfile” → “set up the Caddyfile” (
setupis a noun).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (8)
apps/docs/package-lock.jsonis excluded by!**/package-lock.jsonapps/docs/public/cover.pngis excluded by!**/*.pngapps/docs/public/favicon.icois excluded by!**/*.icoapps/docs/public/img/nestri-logo-sm.svgis excluded by!**/*.svgapps/docs/public/img/nestri-logo.pngis excluded by!**/*.pngapps/docs/public/img/nestri-logo.svgis excluded by!**/*.svgapps/docs/public/logo.svgis excluded by!**/*.svgpackage-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (46)
README.md(3 hunks)apps/docs/.eslintrc.cjs(0 hunks)apps/docs/.gitignore(1 hunks)apps/docs/.npmrc(1 hunks)apps/docs/README.md(1 hunks)apps/docs/RELAY.md(0 hunks)apps/docs/app.config.ts(1 hunks)apps/docs/assets/css/tailwind.css(1 hunks)apps/docs/components/AppSocialIcons.vue(0 hunks)apps/docs/components/Logo.vue(0 hunks)apps/docs/components/content/Contributors.vue(3 hunks)apps/docs/components/layout/Header/Logo.vue(1 hunks)apps/docs/content/0.index.md(0 hunks)apps/docs/content/1.introduction/1.what-is-nestri.md(1 hunks)apps/docs/content/1.introduction/2.faq.md(2 hunks)apps/docs/content/1.introduction/_dir.yml(1 hunks)apps/docs/content/2.nestri-node/1.what-is-nestri-node.md(1 hunks)apps/docs/content/2.nestri-node/2.prerequisite.md(1 hunks)apps/docs/content/2.nestri-node/3.getting-started.md(1 hunks)apps/docs/content/2.nestri-node/4.troubleshooting.md(0 hunks)apps/docs/content/2.nestri-node/5.container-cli.md(1 hunks)apps/docs/content/2.nestri-node/6.node-faq.md(1 hunks)apps/docs/content/2.nestri-node/7.developer-notes.md(1 hunks)apps/docs/content/2.nestri-node/_dir.yml(1 hunks)apps/docs/content/3.nestri-relay/1.what-is-nestri-node.md(0 hunks)apps/docs/content/3.nestri-relay/1.what-is-nestri-relay.md(1 hunks)apps/docs/content/3.nestri-relay/2.selfhosted-nestri-relay.md(2 hunks)apps/docs/content/3.nestri-relay/3.container-cli.md(1 hunks)apps/docs/content/3.nestri-relay/3.deploy-moq.md(0 hunks)apps/docs/content/3.nestri-relay/4.advanced-users.md(0 hunks)apps/docs/content/3.nestri-relay/5.moq-tester.md(0 hunks)apps/docs/content/3.nestri-relay/_dir.yml(1 hunks)apps/docs/content/4.nestri-internal/1.what-is-this.md(0 hunks)apps/docs/content/4.nestri-internal/2.setup.md(0 hunks)apps/docs/content/4.nestri-internal/_dir.yml(0 hunks)apps/docs/content/index.md(1 hunks)apps/docs/nuxt.config.ts(1 hunks)apps/docs/package.json(1 hunks)apps/docs/renovate.json(0 hunks)apps/docs/sst-env.d.ts(0 hunks)apps/docs/tailwind.config.js(1 hunks)apps/docs/tokens.config.ts(0 hunks)apps/docs/tsconfig.json(1 hunks)containers/Caddyfile(1 hunks)containers/docker-compose.relay.caddy.yml(1 hunks)containers/docker-compose.relay.traefik.yml(1 hunks)
💤 Files with no reviewable changes (16)
- apps/docs/content/2.nestri-node/4.troubleshooting.md
- apps/docs/sst-env.d.ts
- apps/docs/components/Logo.vue
- apps/docs/content/3.nestri-relay/5.moq-tester.md
- apps/docs/content/4.nestri-internal/_dir.yml
- apps/docs/content/4.nestri-internal/2.setup.md
- apps/docs/renovate.json
- apps/docs/.eslintrc.cjs
- apps/docs/content/3.nestri-relay/3.deploy-moq.md
- apps/docs/content/4.nestri-internal/1.what-is-this.md
- apps/docs/RELAY.md
- apps/docs/content/3.nestri-relay/4.advanced-users.md
- apps/docs/components/AppSocialIcons.vue
- apps/docs/content/3.nestri-relay/1.what-is-nestri-node.md
- apps/docs/content/0.index.md
- apps/docs/tokens.config.ts
🧰 Additional context used
🪛 YAMLlint (1.37.1)
apps/docs/content/2.nestri-node/_dir.yml
[error] 3-3: no new line character at the end of file
(new-line-at-end-of-file)
apps/docs/content/3.nestri-relay/_dir.yml
[error] 3-3: no new line character at the end of file
(new-line-at-end-of-file)
apps/docs/content/1.introduction/_dir.yml
[error] 3-3: no new line character at the end of file
(new-line-at-end-of-file)
containers/docker-compose.relay.caddy.yml
[error] 33-33: no new line character at the end of file
(new-line-at-end-of-file)
containers/docker-compose.relay.traefik.yml
[error] 26-26: duplication of key "restart" in mapping
(key-duplicates)
[error] 52-52: no new line character at the end of file
(new-line-at-end-of-file)
🪛 LanguageTool
apps/docs/README.md
[grammar] ~48-~48: This sentence should probably be started with a verb instead of the noun ‘Checkout’. If not, consider inserting a comma for better clarity.
Context: ...on build: bash npm run preview Checkout the [deployment documentation](https://...
(SENT_START_NN_DT)
apps/docs/content/2.nestri-node/1.what-is-nestri-node.md
[misspelling] ~7-~7: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...n most Linux-based systems and requires a NVIDIA, AMD or Intel graphics card.
(EN_A_VS_AN)
apps/docs/content/index.md
[uncategorized] ~5-~5: Loose punctuation mark.
Context: --- title: Home navigation: false --- ::hero --- announcement: title: 'We are...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~26-~26: Loose punctuation mark.
Context: ...th your friends on your own game cloud. :: ::contributors ::
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~28-~28: Loose punctuation mark.
Context: ...our friends on your own game cloud. :: ::contributors ::
(UNLIKELY_OPENING_PUNCTUATION)
apps/docs/content/2.nestri-node/7.developer-notes.md
[uncategorized] ~20-~20: Possible missing comma found.
Context: ...sh ``` For most games that are not DRM free you need a launcher. In this case use t...
(AI_HYDRA_LEO_MISSING_COMMA)
[formatting] ~20-~20: Consider inserting a comma after an introductory phrase for better readability.
Context: ...t are not DRM free you need a launcher. In this case use the umu launcher: ```bash [install ...
(IN_THAT_CASE_COMMA)
[uncategorized] ~25-~25: Possible missing comma found.
Context: ...th the nestri user. If you have a linux game execute it like so: ```bash [execute ga...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~33-~33: Loose punctuation mark.
Context: ...nchers like Lutris to run other games. ::alert{type="danger"} Warning: Runni...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~35-~35: Loose punctuation mark.
Context: ...es. We cannot provide support for this. ::
(UNLIKELY_OPENING_PUNCTUATION)
apps/docs/content/2.nestri-node/3.getting-started.md
[uncategorized] ~6-~6: Loose punctuation mark.
Context: ...: 'lucide:message-circle-question' --- ::alert{type="danger"} Nestri is in a **v...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~8-~8: Loose punctuation mark.
Context: ... phase**, so errors and bugs may occur. :: ::alert{type="info"} You can pull the...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~10-~10: Loose punctuation mark.
Context: ...se**, so errors and bugs may occur. :: ::alert{type="info"} You can pull the doc...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~15-~15: Loose punctuation mark.
Context: ...io/nestrilabs/nestri/runner:nightly ``` :: ### Step 1: Create a home directory f...
(UNLIKELY_OPENING_PUNCTUATION)
[misspelling] ~29-~29: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...also need to replace <room_name> with an unique name for the room you will be us...
(EN_A_VS_AN)
[style] ~53-~53: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... ### Start the Nestri Container If you want to start the Nestri container after stoppi...
(REP_WANT_TO_VB)
apps/docs/content/2.nestri-node/2.prerequisite.md
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ...er. ## Recommended host configuration ::list{type="primary"} - **AMD, NVIDIA or...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~22-~22: Loose punctuation mark.
Context: ...tribution :: ## Software Requirements ::list{type="primary"} - GPU Drivers ...
(UNLIKELY_OPENING_PUNCTUATION)
apps/docs/content/1.introduction/1.what-is-nestri.md
[uncategorized] ~23-~23: You might be missing the article “a” here.
Context: ...(Selective Forwarding Unit) that splits single incoming stream to multiple potential p...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
apps/docs/content/2.nestri-node/5.container-cli.md
[uncategorized] ~15-~15: A determiner appears to be missing. Consider inserting it.
Context: ...60 | Display/stream framerate. Default is 60 FPS. ...
(AI_EN_LECTOR_MISSING_DETERMINER)
[uncategorized] ~19-~19: A determiner appears to be missing. Consider inserting it.
Context: ...ring` | -1 | GPU index to use. Default is -1 (auto-select). ...
(AI_EN_LECTOR_MISSING_DETERMINER)
[uncategorized] ~23-~23: A determiner appears to be missing. Consider inserting it.
Context: ...control method. Options: cqp, vbr, cbr. Default is cbr. | | `--vid...
(AI_EN_LECTOR_MISSING_DETERMINER)
[uncategorized] ~24-~24: A determiner appears to be missing. Consider inserting it.
Context: ...t Quantization Parameter (CQP) quality. Default is 26. | | `--video...
(AI_EN_LECTOR_MISSING_DETERMINER)
[uncategorized] ~26-~26: A determiner appears to be missing. Consider inserting it.
Context: ... 8000 | Maximum bitrate in kbps. Default is 8000 kbps. ...
(AI_EN_LECTOR_MISSING_DETERMINER)
[uncategorized] ~26-~26: Possible missing comma found.
Context: ... | Maximum bitrate in kbps. Default is 8000 kbps. ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~29-~29: A determiner appears to be missing. Consider inserting it.
Context: ... | opus | Preferred audio codec. Default is opus. ...
(AI_EN_LECTOR_MISSING_DETERMINER)
[grammar] ~29-~29: Is an article like ‘a’ or ‘an’ missing?
Context: ... | Preferred audio codec. Default is opus. ...
(BE_NN)
[uncategorized] ~31-~31: A determiner appears to be missing. Consider inserting it.
Context: ...control method. Options: cqp, vbr, cbr. Default is cbr. | | `--audio-bit...
(AI_EN_LECTOR_MISSING_DETERMINER)
[uncategorized] ~32-~32: A determiner appears to be missing. Consider inserting it.
Context: ... | Target audio bitrate in kbps. Default is 128 kbps. ...
(AI_EN_LECTOR_MISSING_DETERMINER)
[uncategorized] ~33-~33: A determiner appears to be missing. Consider inserting it.
Context: ... | Maximum audio bitrate in kbps. Default is 192 kbps. ...
(AI_EN_LECTOR_MISSING_DETERMINER)
apps/docs/content/1.introduction/2.faq.md
[formatting] ~32-~32: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...nce you’re aiming for. Keep in mind that, because Nestri has to use a GPU to encode the g...
(COMMA_BEFORE_BECAUSE)
[uncategorized] ~34-~34: A determiner appears to be missing. Consider inserting it.
Context: ...ng required. ## Do you have an app for phone or TV? Not yet! At the moment, we don...
(AI_EN_LECTOR_MISSING_DETERMINER)
[style] ~35-~35: For conciseness, consider replacing this expression with an adverb.
Context: ...have an app for phone or TV? Not yet! At the moment, we don’t have a dedicated app. However...
(AT_THE_MOMENT)
[style] ~56-~56: Using many exclamation marks might seem excessive (in this case: 10 exclamation marks for a text that’s 4798 characters long)
Context: ... hosted solution, Nestri has you covered!
(EN_EXCESSIVE_EXCLAMATION)
README.md
[style] ~90-~90: Using many exclamation marks might seem excessive (in this case: 6 exclamation marks for a text that’s 2331 characters long)
Context: ...https://polar.sh/nestri) Happy Gaming! 🎮🔥 [github-release-link]: https:/...
(EN_EXCESSIVE_EXCLAMATION)
apps/docs/content/3.nestri-relay/2.selfhosted-nestri-relay.md
[style] ~3-~3: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...which we highly recommend for those who want to start playing quickly on their own hard...
(REP_WANT_TO_VB)
[grammar] ~23-~23: The grammatical number of this noun might be incorrect. Did you mean to use the singular form here?
Context: ... Certificate**: This is the most common certificates for self-hosting and requires a domain ...
(SUPERLATIVE_NUMBER)
[grammar] ~25-~25: A determiner may be missing.
Context: ... - Purchased SSL Certificate: The easiest option for most users is to buy an SS...
(THE_SUPERLATIVE)
[misspelling] ~44-~44: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...sers. ## Self-hosted Nestri Relay with an Reverse Proxy ### Caddy As caddy user ...
(EN_A_VS_AN)
[uncategorized] ~47-~47: Possible missing comma found.
Context: ...th an Reverse Proxy ### Caddy As caddy user you can use the following docker-compos...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~99-~99: The word “setup” is a noun. The verb is spelled with a space.
Context: ...r values with your own. You should also setup the Caddyfile to match your domain. ##...
(NOUN_VERB_CONFUSION)
[uncategorized] ~102-~102: You might be missing the article “a” here.
Context: ...e to match your domain. ### Traefik As traefik user you can use the following docker-c...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~102-~102: Possible missing comma found.
Context: ...ch your domain. ### Traefik As traefik user you can use the following docker-compos...
(AI_HYDRA_LEO_MISSING_COMMA)
🪛 markdownlint-cli2 (0.17.2)
apps/docs/README.md
20-20: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
21-21: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
22-22: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
23-23: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
25-25: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
27-27: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
28-28: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
apps/docs/content/index.md
11-11: Bare URL used
null
(MD034, no-bare-urls)
14-14: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
16-16: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
18-18: Bare URL used
null
(MD034, no-bare-urls)
22-22: No space after hash on atx style heading
null
(MD018, no-missing-space-atx)
25-25: No space after hash on atx style heading
null
(MD018, no-missing-space-atx)
README.md
90-90: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
110-110: Link and image reference definitions should be needed
Unused link or image reference definition: "vmaf-cuda-link"
(MD053, link-image-reference-definitions)
apps/docs/content/3.nestri-relay/2.selfhosted-nestri-relay.md
10-10: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
11-11: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
12-12: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
14-14: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
15-15: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
23-23: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
25-25: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
33-33: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
34-34: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
🔇 Additional comments (23)
apps/docs/.gitignore (4)
1-8: Approve build output ignore patternsThe new ignore entries for Nuxt build outputs and cache directories are comprehensive and correctly scoped.
13-15: Approve logs ignore sectionThe patterns for
logsand*.logeffectively cover runtime log files.
17-18: Approve miscellaneous ignore rulesIgnoring
.DS_Storeand.fleetalongside IDE settings is appropriate.
24-25: Approve environment file ignore rulesThe rules to ignore all
.env.*while preserving.env.exampleare correctly configured.apps/docs/tailwind.config.js (4)
1-5: Import and core settings look goodThe
tailwindcss-animateplugin is properly imported, and the base options (darkMode,safelist,prefix) are correctly configured.
19-53: Extended theme colors are well-structuredThe CSS variable–based palette for semantic tokens covers primary, secondary, destructive, muted, accent, popover, and card layers with matching foregrounds.
60-83: Keyframe animations and motion utilitiesThe custom keyframes and animation utilities align with Radix UI patterns and provide smooth accordion/collapsible behaviors.
87-88: Plugin registration is correctThe
tailwindcss-animateplugin is correctly added to thepluginsarray.containers/Caddyfile (1)
1-8: Verify placeholder domain and emailReplace
relay.example.comandyou@example.comwith your actual domain and TLS email before deployment to ensure certificate issuance succeeds.apps/docs/.npmrc (1)
2-2: Confirm peer dependency settingDisabling strict peer dependencies (
strict-peer-dependencies=false) can mask version conflicts. Ensure this is intentional for your npm workflow and won’t introduce hidden compatibility issues.apps/docs/tsconfig.json (1)
2-3: Align TypeScript config with Nuxt defaults
RemovingignoreConfigErrorsand extending Nuxt's generated TS config ensures proper type checking and consistency with the framework.apps/docs/content/1.introduction/_dir.yml (1)
1-3: Documentation metadata updated correctlyThe new
title,icon, andnavigation.redirectfields accurately describe and link the introduction section.apps/docs/content/2.nestri-node/6.node-faq.md (2)
8-8: Approve Debian/Ubuntu support clarificationThe updated answer correctly reflects that Debian/Ubuntu support is now possible but not recommended.
14-14: Approve Windows support statementThe answer clearly states that Windows-based systems are not supported and correctly highlights Linux-only deployment.
apps/docs/nuxt.config.ts (1)
4-6: Nuxt config updated for new themeReplacing the theme with
shadcn-docs-nuxtand updatingcompatibilityDatealigns with the migration plan.apps/docs/components/content/Contributors.vue (2)
6-6: Add dark mode support to headingThe
dark:text-whiteclass correctly ensures the heading remains visible in dark mode.
36-38: Ensure badge color inversion in dark modeThe added
dark:bg-whiteanddark:text-gray-950classes correctly invert the index badge for dark mode.apps/docs/package.json (1)
2-4: Project metadata updated appropriatelyRenaming to
"shadcn-docs-nuxt-starter"and setting"type": "module"aligns with the modular Nuxt setup.apps/docs/content/index.md (1)
8-19: Incorrect indentation breaks markdown-component front-matterYAML lists must be indented consistently; otherwise the site generator may fail to parse
actions.-actions: - - name: Documentation - to: /introduction/what-is-nestri - - name: GitHub - variant: outline - to: https://github.com/nestrilabs/nestri - leftIcon: 'lucide:github' +actions: + - name: Documentation + to: /introduction/what-is-nestri + - name: GitHub + variant: outline + to: https://github.com/nestrilabs/nestri + leftIcon: 'lucide:github'Likely an incorrect or invalid review comment.
containers/docker-compose.relay.caddy.yml (1)
17-18: Use official Nestri Relay image
The commented-outghcr.io/nestrilabs/nestri/relay:nightlyis the upstream image. Confirm whetherdatcaptainhorse/nestri-relay:latestis intentional and consider switching back to the official registry for consistency.apps/docs/content/2.nestri-node/2.prerequisite.md (1)
18-19: Clarify OS support
This recommends only Fedora or Arch. Should we explicitly note that Debian/Ubuntu are unsupported or require additional configuration?README.md (1)
48-52: Ubuntu support wording conflicts with existing docsHere it says “Ubuntu works but is not recommended”, whereas other docs (and the review discussion) state Ubuntu is not supported. Please reconcile to avoid confusing users.
apps/docs/content/3.nestri-relay/2.selfhosted-nestri-relay.md (1)
147-154: Traefik labels – missing UDP support noteWebRTC media is over UDP 8088. Traefik will forward only TCP unless
entryPoints.websecure.udp(or a separate UDP router) is configured. Add a note or example to prevent silent one-way media failures.
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
README.md (2)
1-5: Consider using Markdown image syntax
Leveraging Markdown syntax () improves readability and renders consistently across platforms.Proposed change:
- <p align="center"> - <a href="https://nestri.io"> - <img src="apps/docs/public/README.png" alt="Nestri logo" /> - </a> - </p> + [](https://nestri.io)
7-8: Replace HTML headings with Markdown
Switch to native Markdown headings to simplify the README and ensure consistent styling.Proposed change:
- <h1 align="center">nestri</h1> - <p align="center"><i>Open-source cloud gaming platform</i></p> + # nestri + *Open-source cloud gaming platform*
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
apps/docs/public/README.pngis excluded by!**/*.png
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
3-3: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Build and deploy docs
|
@coderabbitai can you create an issue where i flesh out the README file. Thanks! |
|
Merging this as is |
|
@coderabbitai resolve all |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
README.md (2)
3-3: Fix wording in the tagline
Opensourceshould be written as two words. A hyphenated form is clearer and more common in OSS READMEs.-Opensource and selfhostable cloud gaming platform +Open-source and self-hostable cloud-gaming platform.
5-6: Remove TODO placeholder before mergeLeaving TODO blocks in the default branch looks unpolished. Either flesh the section out or drop it.
-> TIP -> TODO: Finish up on this README +For full documentation, please see the docs site ➜ https://docs.nestri.dev
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
apps/docs/public/README.pngis excluded by!**/*.png
📒 Files selected for processing (1)
README.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Build and deploy docs
🔇 Additional comments (1)
README.md (1)
1-6: README is now too minimal—add a docs pointerSince most information has moved to
apps/docs, newcomers have no installation or usage hint. At minimum, add a “Getting started” link to the docs before merging.
|
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:
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? 🐰✨ |
|
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: Length of output: 1684 Perfect! I've successfully created GitHub issue #296 to track the README enhancement work. Issue created: #296 The issue includes:
The issue provides a solid roadmap for creating a comprehensive README that balances informativeness with visual appeal while ensuring consistency with your documentation. |
|
@coderabbitai resolve |
✅ Actions performedComments resolved. |
5 participants
Description
Update the readme file
Related Issues
none
Type of Change
Checklist
Notes for Reviewers
none
Screenshots/Demo
none
Additional Context
none
Summary by CodeRabbit
Documentation
Chores
Style
New Features