docs: add supported archs #2017
Conversation
WalkthroughA new "Supported architectures" section was added to three documentation files: the celestia-app installation guide, the celestia-node guide, and the environment setup guide. This section specifically lists the four officially supported and tested architectures: linux/amd64, linux/arm64, darwin/amd64 (macOS Intel), and darwin/arm64 (macOS Apple Silicon). No other changes were made to the content or procedures in these guides. Changes
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:
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: 0
🧹 Nitpick comments (3)
how-to-guides/environment.md (1)
20-29: Supported architectures section correctly added
The new “Supported architectures” section accurately enumerates the four officially tested platforms and is placed appropriately before the dependency installation steps, improving clarity for users.
Consider unifying the introductory phrasing across all guides (e.g., consistently using “only officially support” vs. “officially support”) to maintain a uniform voice.how-to-guides/celestia-app.md (1)
23-32: Supported architectures section correctly added
The section concisely lists all supported platforms for celestia-app, matching the style and placement seen in related guides.
For consistency, you may want to standardize the intro sentence across documentation (e.g., include “only officially support” if used elsewhere).how-to-guides/celestia-node.md (1)
15-24: Supported architectures section correctly added
This section clearly highlights the four official architectures for celestia-node and aligns with the structure in other how-to guides.
Optionally, you could harmonize the wording across all docs (for example, uniformly using “only officially support”).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
how-to-guides/celestia-app.md(1 hunks)how-to-guides/celestia-node.md(1 hunks)how-to-guides/environment.md(1 hunks)
There was a problem hiding this comment.
Pull Request Overview
This PR adds a new "Supported architectures" section to the installation and environment setup guides to clearly document which operating systems and hardware architectures are officially supported for Celestia-app and celestia-node.
- Added a supported architectures list in environment.md
- Added a supported architectures section in celestia-node.md
- Added a supported architectures section in celestia-app.md
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| how-to-guides/environment.md | Introduced a new section listing supported architectures. |
| how-to-guides/celestia-node.md | Added an identical supported architectures section for celestia-node. |
| how-to-guides/celestia-app.md | Added a supported architectures section for celestia-app. |
Comments suppressed due to low confidence (1)
how-to-guides/environment.md:22
- [nitpick] Consider standardizing the capitalization of 'Celestia-app' and 'celestia-node' for consistency across documents. For example, use 'Celestia-App' and 'Celestia-Node' consistently.
Celestia-app and celestia-node only officially support the following architectures:
Overview
Adds notes about supported architectures from celestiaorg/celestia-node#4247 (comment)
Summary by CodeRabbit