Fix: arch directions #29

2025-07-08T21:30:29-04:00

Owen-sz commented

2025-07-08 21:30:29 -04:00

(Migrated from github.com)

Not sure if the 'then in another terminal window or tab, run any other clients you need. We recommend flatland and hexagon-launcher.' is also accurate?

Summary by CodeRabbit

Documentation
- Updated the getting started guide to recommend launching Stardust using the telescope command instead of stardust-xr-server.

Not sure if the 'then in another terminal window or tab, run any other clients you need. We recommend `flatland` and `hexagon-launcher`.' is also accurate?  ## Summary by CodeRabbit * **Documentation** * Updated the getting started guide to recommend launching Stardust using the `telescope` command instead of `stardust-xr-server`.

coderabbitai[bot] commented

2025-07-08 21:30:35 -04:00

(Migrated from github.com)

📝 Walkthrough

Walkthrough

The documentation was updated to recommend launching Stardust using the telescope command instead of the previously suggested stardust-xr-server. Instructions for running additional clients in separate terminals remain unchanged.

Changes

File	Change Summary
docs/01-get-started/04-manual.md	Updated launch command from `stardust-xr-server` to `telescope` in documentation.

Sequence Diagram(s)

No sequence diagram generated as the change only affects documentation instructions.

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

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

<details> <summary>📝 Walkthrough</summary> ## Walkthrough The documentation was updated to recommend launching Stardust using the `telescope` command instead of the previously suggested `stardust-xr-server`. Instructions for running additional clients in separate terminals remain unchanged. ## Changes | File | Change Summary | |-------------------------------|----------------------------------------------| | docs/01-get-started/04-manual.md | Updated launch command from `stardust-xr-server` to `telescope` in documentation. | ## Sequence Diagram(s) *No sequence diagram generated as the change only affects documentation instructions.* </details>      --- 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. <details> <summary>❤️ Share</summary> - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code) </details> <details> <summary>🪧 Tips</summary> ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai?utm_source=oss&utm_medium=github&utm_campaign=StardustXR/website&utm_content=29): - 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](https://www.coderabbit.ai/contact-us/support) 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](https://docs.coderabbit.ai/finishing-touches/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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements. </details>

coderabbitai[bot] (Migrated from github.com) reviewed 2025-07-08 21:32:09 -04:00

coderabbitai[bot] (Migrated from github.com) left a comment

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/01-get-started/04-manual.md (1)
56-56: Re-phrase for clarity & fix spacing glitch

The current sentence is a bit long and LanguageTool flagged the double-space before “We”. A crisper split also reads better:
-From there, you can launch Stardust with `stardust-xr-telescope`, then in another terminal window or tab, run any other clients you need. We recommend `flatland` and `hexagon-launcher`.
+From there, launch Stardust with `stardust-xr-telescope`.  
+In another terminal window or tab, start any additional clients you need – we recommend `flatland` and `hexagon-launcher`.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7edcb4f2f3 and d6031e4b41.

📒 Files selected for processing (1)

docs/01-get-started/04-manual.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/01-get-started/04-manual.md

[grammar] ~56-~56: Use correct spacing
Context: ...s you need. We recommend flatland and hexagon-launcher. # Manual Build :::caution Make sure a...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

🔇 Additional comments (1)

docs/01-get-started/04-manual.md (1)

42-56: Double-check server vs. telescope instructions

Lines 42-54 still instruct users to install stardust-xr-server, yet the text below (line 56) tells them to launch via stardust-xr-telescope.
If Telescope already depends on / spawns the server, listing the server package separately (and the earlier paragraph that says “typical way is to first run the server”) could confuse newcomers.

Please verify:

Does Telescope implicitly start the server?

If so, can the explicit paru -s stardust-xr-server line be removed, or should the launch sentence revert to stardust-xr-server?

Clarifying this keeps the Arch instructions internally consistent.

**Actionable comments posted: 0** <details> <summary>🧹 Nitpick comments (1)</summary><blockquote> <details> <summary>docs/01-get-started/04-manual.md (1)</summary><blockquote> `56-56`: **Re-phrase for clarity & fix spacing glitch** The current sentence is a bit long and LanguageTool flagged the double-space before “We”. A crisper split also reads better: ```diff -From there, you can launch Stardust with `stardust-xr-telescope`, then in another terminal window or tab, run any other clients you need. We recommend `flatland` and `hexagon-launcher`. +From there, launch Stardust with `stardust-xr-telescope`. +In another terminal window or tab, start any additional clients you need – we recommend `flatland` and `hexagon-launcher`. ``` </blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: CodeRabbit UI** **Review profile: CHILL** **Plan: Pro** <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 7edcb4f2f3fb034d94ddb7c9184ad80e21d7c29f and d6031e4b410b72a60fc72aaa9214e3615d40fb6e. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `docs/01-get-started/04-manual.md` (1 hunks) </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 LanguageTool</summary> <details> <summary>docs/01-get-started/04-manual.md</summary> [grammar] ~56-~56: Use correct spacing Context: ...s you need. We recommend `flatland` and `hexagon-launcher`. # Manual Build :::caution Make sure a... (QB_NEW_EN_OTHER_ERROR_IDS_5) </details> </details> </details> <details> <summary>🔇 Additional comments (1)</summary><blockquote> <details> <summary>docs/01-get-started/04-manual.md (1)</summary> `42-56`: **Double-check server vs. telescope instructions** Lines 42-54 still instruct users to install `stardust-xr-server`, yet the text below (line 56) tells them to launch via `stardust-xr-telescope`. If Telescope already depends on / spawns the server, listing the server package separately (and the earlier paragraph that says “typical way is to first run the server”) could confuse newcomers. Please verify: 1. Does Telescope implicitly start the server? 2. If so, can the explicit `paru -s stardust-xr-server` line be removed, or should the launch sentence revert to `stardust-xr-server`? Clarifying this keeps the Arch instructions internally consistent. </details> </blockquote></details> </details>

coderabbitai[bot] (Migrated from github.com) reviewed 2025-07-08 21:34:14 -04:00

coderabbitai[bot] (Migrated from github.com) left a comment

Actionable comments posted: 0

🧹 Nitpick comments (2)

docs/01-get-started/04-manual.md (2)
53-56: Potentially redundant stardust-xr-server entry in the install list

Line 56 now instructs users to start Stardust via the telescope wrapper, yet the package list above still tells them to install stardust-xr-server directly.

If telescope internally launches the server binary shipped inside stardust-xr-server, users still need the package—otherwise, documenting both is confusing. If telescope bundles its own server or pulls it in as a dependency, installing stardust-xr-server explicitly is redundant.

Please double-check the dependency chain and either:

drop paru -s stardust-xr-server from the list, or

add a short clarification (“telescope requires the stardust-xr-server package, so keep it installed, but you don’t run it directly.”).

56-57: Trim the double-space after the period

LanguageTool flags an extra two-space sequence before the next heading. It isn’t harmful for Markdown but it’s unnecessary noise.
-From there, you can launch Stardust with `telescope`, then in another terminal window or tab, run any other clients you need. We recommend `flatland` and `hexagon-launcher`.  
+From there, you can launch Stardust with `telescope`, then in another terminal window or tab, run any other clients you need. We recommend `flatland` and `hexagon-launcher`.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d6031e4b41 and fe47999802.

📒 Files selected for processing (1)

docs/01-get-started/04-manual.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/01-get-started/04-manual.md

[grammar] ~56-~56: Use correct spacing
Context: ...s you need. We recommend flatland and hexagon-launcher. # Manual Build :::caution Make sure a...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

**Actionable comments posted: 0** <details> <summary>🧹 Nitpick comments (2)</summary><blockquote> <details> <summary>docs/01-get-started/04-manual.md (2)</summary><blockquote> `53-56`: **Potentially redundant `stardust-xr-server` entry in the install list** Line 56 now instructs users to start Stardust via the `telescope` wrapper, yet the package list above still tells them to install `stardust-xr-server` directly. If `telescope` internally launches the server binary shipped inside `stardust-xr-server`, users still need the package—otherwise, documenting both is confusing. If `telescope` bundles its own server or pulls it in as a dependency, installing `stardust-xr-server` explicitly is redundant. Please double-check the dependency chain and either: 1. drop `paru -s stardust-xr-server` from the list, or 2. add a short clarification (“`telescope` requires the `stardust-xr-server` package, so keep it installed, but you don’t run it directly.”). --- `56-57`: **Trim the double-space after the period** LanguageTool flags an extra two-space sequence before the next heading. It isn’t harmful for Markdown but it’s unnecessary noise. ```diff -From there, you can launch Stardust with `telescope`, then in another terminal window or tab, run any other clients you need. We recommend `flatland` and `hexagon-launcher`. +From there, you can launch Stardust with `telescope`, then in another terminal window or tab, run any other clients you need. We recommend `flatland` and `hexagon-launcher`. ``` </blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: CodeRabbit UI** **Review profile: CHILL** **Plan: Pro** <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between d6031e4b410b72a60fc72aaa9214e3615d40fb6e and fe47999802eb833655ac85e82030804f6912552c. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `docs/01-get-started/04-manual.md` (1 hunks) </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 LanguageTool</summary> <details> <summary>docs/01-get-started/04-manual.md</summary> [grammar] ~56-~56: Use correct spacing Context: ...s you need. We recommend `flatland` and `hexagon-launcher`. # Manual Build :::caution Make sure a... (QB_NEW_EN_OTHER_ERROR_IDS_5) </details> </details> </details> </details>

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: StardustXR/website#29