feat: add specter docs #218
Conversation
Signed-off-by: Smuu <[email protected]>
WalkthroughA new documentation file Changes
Poem
Tip 🌐 Web search-backed reviews and chat
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (4)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 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: 3
🧹 Nitpick comments (3)
doc/src/specter-devnet.md (3)
1-3: Consider adding explicit security warning about mock proofs.While the development/testing warning is clear, consider adding an explicit security warning about the implications of using mock proofs. This helps prevent misuse and potential security risks.
# 👻 Specter Devnet: Enter the Haunted Realm 👻 -Welcome, valiant explorer, to the Prism Specter Devnet—your gateway to the powerful capabilities of the based rollup on Celestia's Mocha testnet. Proceed with caution! This devnet is currently populated with mock proofs and is intended solely for development and testing purposes. **It is not suitable for production use.** Please be aware that the Specter Devnet may undergo changes at any time, including breaking modifications that could affect your work. +Welcome, valiant explorer, to the Prism Specter Devnet—your gateway to the powerful capabilities of the based rollup on Celestia's Mocha testnet. Proceed with caution! This devnet is currently populated with mock proofs and is intended solely for development and testing purposes. **It is not suitable for production use and offers no security guarantees due to the use of mock proofs.** Please be aware that the Specter Devnet may undergo changes at any time, including breaking modifications that could affect your work.
47-62: Enhance network endpoints section with operational details.Consider adding important operational information:
- API rate limits and quotas
- Expected uptime/SLA
- Contact information for endpoint-specific issues
- Any authentication requirements
65-68: Expand troubleshooting section with common solutions.Consider enhancing the troubleshooting section with:
- Common issues and their solutions
- Instructions for enabling debug logs
- Bug report template with required information
- Links to relevant Discord/community channels
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
doc/src/SUMMARY.md(1 hunks)doc/src/specter-devnet.md(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- doc/src/SUMMARY.md
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: unit-test
- GitHub Check: integration-test
- GitHub Check: unused dependencies
| Unlock the secrets of the Specter Devnet with this verifying key (for testing purposes only): | ||
| `L2ilppK59Kq3aAMB/wpxdVGaI53DHPMdY6fcRodyFaA=` | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add context about the verifying key's format and usage.
The verifying key section would benefit from additional information about:
- The key's encoding format (base64)
- Instructions or examples of how to use this key
- Where this key should be configured
| ## 🕸️ How to Use the Specter Devnet 🕸️ | ||
|
|
||
| Coming soon: **Detailed instructions will soon materialize from the shadows. Stay tuned!** |
There was a problem hiding this comment.
Critical section marked as "Coming soon".
The "How to Use" section is essential for users to get started with the devnet. Consider:
- Adding basic usage instructions in this PR
- Creating a follow-up issue to track the detailed documentation
- Including temporary workarounds or references
| - **Celestia DA**: `e11cd71` | ||
| - **Prism**: `pr-205` |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Enhance version references with links and semantic versions.
The current version references using commit hash and PR number could be improved:
- Add links to the specific commits/PRs
- Include semantic versions where available
- Consider adding release tags instead of commit hashes
-- **Celestia DA**: `e11cd71`
-- **Prism**: `pr-205`
+- **Celestia DA**: [`e11cd71`](https://github.com/celestiaorg/celestia-node/commit/e11cd71) (v0.x.x)
+- **Prism**: [PR #205](https://github.com/deltadevsde/prism/pull/205) (upcoming v0.x.x)Committable suggestion skipped: line range outside the PR's diff.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Skipped Deployment
|
|
Let's move this to the actual docs and then link to the docs. Will commit directly to this PR |
Summary by CodeRabbit