Added Quick start guide and simplified gm-world tutorial #360
Conversation
- add script for installing Go from source, platform agnostic - add script for installing Rollkit cli by building it from source under the hood
|
Note Reviews PausedUse the following commands to manage reviews:
WalkthroughThe recent updates focus on enhancing user navigation and tutorial accessibility in documentation, alongside introducing and refining scripts for streamlined development setups. Key changes include link updates in Changes
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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
|
first we need to merge it, otherwise links will not work :) |
yarikbratashchuk
changed the title
|
@jcstein is there a way to create a short links and redirect to raw.githubusercontent.com for our links? From what I checked there is a way to do this with a server, but maybe there is some trick without it? |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Out of diff range and nitpick comments (5)
tutorials/wordle.md (5)
Line range hint
9-9: Consider using "set up" instead of "setup" when used as a verb.
Line range hint
17-17: Correct the capitalization of "GitHub" in the link text.- Github + GitHub
Line range hint
129-129: Use "set up" instead of "setup" when used as a verb.
Line range hint
83-83: Consider using a more formal alternative to "amazing" to maintain a professional tone in documentation.- Ignite is an amazing CLI tool to help us get started building our own blockchains for cosmos-sdk apps. + Ignite is an exceptional CLI tool to help us get started building our own blockchains for cosmos-sdk apps.
Line range hint
162-162: The table formatting is incorrect due to a missing trailing pipe. Ensure that each row in the table ends with a pipe (|) for proper Markdown formatting.- | readme.md | A readme file for your sovereign application-specific blockchain project. + | readme.md | A readme file for your sovereign application-specific blockchain project. |
There was a problem hiding this comment.
Actionable comments posted: 0
Out of diff range and nitpick comments (3)
tutorials/starter-rollup.md (3)
6-6: Specify supported macOS versions for clarity.It would be beneficial to specify which versions of macOS (e.g., macOS Catalina 10.15 and later) are supported to avoid any confusion for users with older versions.
Line range hint
28-28: Ensure the security of sensitive information.The inclusion of a hardcoded JWT token in the tutorial poses a security risk, even if it's for demonstration purposes. It's recommended to use a placeholder or environment variable instead.
- CELESTIA_NODE_AUTH_TOKEN=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJBbGxvdyI6WyJwdWJsaWMiLCJyZWFkIiwid3JpdGUiLCJhZG1pbiJdfQ.a_-CStbScoe_ot8Z1K9YaccvhngeieiSBdgO4uObuvI + CELESTIA_NODE_AUTH_TOKEN=<YOUR_AUTH_TOKEN_HERE>
Line range hint
1-1: Correct spelling mistakes.There are several spelling mistakes throughout the document. It's important to correct these to maintain the professionalism of the documentation.
|
@coderabbitai resolve |
|
@coderabbitai ignore |
links should work from the preview 👍🏻 |
yes i am going to rework this so that it uses the public directory, which hosts things on existing dns rollkit.dev example use of public folder to retrieve an image in the gm folder https://rollkit.dev/gm/gm.png it will be as plain text aka the script, an example of this is https://docs.celestia.org/nodes/celestia-node#installing-a-pre-built-binary |
|
here is proof from local dev that the scripts work as expected |
|
|
Summary by CodeRabbit
Resolves #361
Summary by CodeRabbit
New Features
jq, Mock-DA, and Rollkit.Documentation
Bug Fixes