chore: add disclaimer that avail-da tutorial is broken #486
Conversation
WalkthroughThe changes in this pull request introduce a warning disclaimer at the beginning of the Changes
Possibly related PRs
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 (
|
RollkitBot
requested review from
Manav-Aggarwal,
tzdybal and
yarikbratashchuk
![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
🧹 Outside diff range and nitpick comments (2)
tutorials/avail-da.md (2)
5-9: Enhance the disclaimer with more specific informationThe addition of the disclaimer is appropriate and helpful. However, consider the following suggestions to make it more informative:
- Specify which parts of the tutorial are broken or what users might encounter if they attempt to follow it.
- Provide an estimated timeline for when the tutorial might be fixed, if possible.
- Consider adding a brief explanation of why the tutorial is currently broken (e.g., due to recent changes in the Avail network).
Additionally, it might be helpful to add a note at the end of the tutorial reminding users about the disclaimer, as they might miss it at the beginning.
Here's a suggested enhancement to the disclaimer:
:::warning Disclaimer This tutorial is currently broken due to recent changes in the Avail network. Specific issues include: - [List specific parts that are not working] - [Any known errors users might encounter] We are actively working on fixing these issues. Follow the progress and estimated completion date in [rollkit/avail-da issue 57](https://github.com/rollkit/avail-da/issues/57). In the meantime, please refer to our [alternative tutorial/documentation] for up-to-date information on deploying rollups to Avail. :::
Line range hint
10-145: Update or annotate the tutorial contentWhile the disclaimer at the beginning is helpful, leaving the rest of the tutorial unchanged could lead to confusion. Consider the following suggestions:
If possible, update the tutorial content to reflect the current state of the Avail network and fix any broken parts.
If immediate updates are not feasible, consider adding inline warnings or notes throughout the tutorial to indicate which specific steps or sections are affected by the current issues.
For each major section (e.g., "Running an Avail light node", "Cleaning previous chain history", etc.), add a note about its current status - whether it's still accurate or needs revision.
If certain parts of the tutorial are still valid and useful, clearly mark these sections as such.
Consider adding a "Known Issues" section near the top of the document, listing specific problems users might encounter when trying to follow this tutorial in its current state.
Here's an example of how you might annotate a section:
## 🪶 Running an Avail light node :::warning This section may be affected by the current issues. Please refer to [issue 57](https://github.com/rollkit/avail-da/issues/57) for the latest status. ::: [existing content...]By providing more context throughout the document, you can help users understand which parts of the tutorial they can still rely on and which parts they should approach with caution.
|
Overview
Summary by CodeRabbit