clean: remove deprecated tutorials #587
Conversation
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 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:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @pthmas, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request focuses on a significant cleanup and maintenance effort for the project's documentation. The primary goal is to remove outdated or deprecated content and ensure all remaining links, both internal and external, are accurate and consistent, improving the overall user experience and navigability of the documentation.
Highlights
- Documentation Cleanup: Removed several deprecated tutorials and blog posts from the documentation sidebar and table of contents, including specific 'Integrations' guides and a 'Sovereign rollups on Bitcoin' article.
- Link Standardization and Correction: Updated numerous internal relative links to use absolute paths for consistency and corrected various external links to point to the latest Celestia documentation URLs and updated repository paths for internal code references.
- Content Refinements: Made minor content adjustments such as correcting an image path and removing an outdated external link within blog and tutorial files.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request focuses on cleaning up deprecated tutorials and updating links across the documentation. The changes are mostly correct and improve the quality of the documentation. I've identified a few issues, including a potentially broken image link, a removed useful link, a link pointing to an unstable branch, and another removed link that provided valuable context. Addressing these points will further enhance the documentation's reliability and usefulness.
| ### Mempool | ||
|
|
||
| The [mempool](https://github.com/rollkit/rollkit/tree/main/mempool) is inspired by the CometBFT mempool. By default, transactions are handled in a First Come, First Served (FCFS) manner. Ordering of transactions can be implemented on the application level; currently this is possible by returning a priority on `CheckTx`, and once we support ABCI++ it is also possible via `PrepareProposal` and the [application mempool](https://docs.cosmos.network/v0.47/building-apps/app-mempool). | ||
| The [mempool](https://github.com/rollkit/go-execution-abci/blob/marko/vn/pkg/rpc/core/mempool.go) is inspired by the CometBFT mempool. By default, transactions are handled in a First Come, First Served (FCFS) manner. Ordering of transactions can be implemented on the application level; currently this is possible by returning a priority on `CheckTx`, and once we support ABCI++ it is also possible via `PrepareProposal` and the [application mempool](https://docs.cosmos.network/v0.53/build/building-apps/app-mempool). |
There was a problem hiding this comment.
This link to the mempool implementation points to a personal feature branch (marko/vn). This is not ideal for documentation as it's likely to be temporary and could be deleted, leading to a broken link. Please update this to point to a file on a stable branch, such as main, or a specific release tag to ensure its longevity.
| By Rollkit | ||
|
|
||
|  | ||
|  |
There was a problem hiding this comment.
The path to this image appears to be incorrect. VitePress serves assets from the public directory, but the public part should not be in the URL path. The previous path /img/Rollkit-cover.jpg was likely correct, assuming the image is located at public/img/Rollkit-cover.jpg.
|  | |
|  |
| Without the overhead of a settlement layer, sovereign rollups can directly interoperate with shared security when using the same DA layer. | ||
|
|
||
| By using a generic application interface like [ABCI++](https://docs.cometbft.com/v0.38/spec/abci/), Rollkit is compatible with the Cosmos SDK, the leading framework for building sovereign blockchains. This enables all Cosmos SDK developers to build a sovereign rollup and tap into all the powerful cosmos ecosystem tooling they’re used to including [IBC](https://www.ibcprotocol.dev/), [ABCI++](https://docs.cometbft.com/v0.38/spec/abci/), and Skip Protocol's [Slinky](https://docs.skip.money/slinky/overview/) and [BlockSDK](https://skip-protocol-docs.netlify.app/blocksdk/overview). | ||
| By using a generic application interface like [ABCI++](https://docs.cometbft.com/v0.38/spec/abci/), Rollkit is compatible with the Cosmos SDK, the leading framework for building sovereign blockchains. This enables all Cosmos SDK developers to build a sovereign rollup and tap into all the powerful cosmos ecosystem tooling they’re used to including [IBC](https://www.ibcprotocol.dev/), [ABCI++](https://docs.cometbft.com/v0.38/spec/abci/), and Skip Protocol's [Slinky](https://docs.skip.money/slinky/overview/) and BlockSDK. |
There was a problem hiding this comment.
The link to the BlockSDK documentation was removed. This link is a useful reference for readers. The original URL redirects to an updated page, so it's still valid. Please consider re-adding it to provide more context.
The updated link is https://docs.skip.money/blocksdk/overview.
| the CosmWasm team for Nameservice purchasing. | ||
|
|
There was a problem hiding this comment.
The link to the example smart contract's source code on GitHub was removed. This was a helpful reference for readers who might want to inspect the contract. Please consider re-adding it to provide valuable context.
| the CosmWasm team for Nameservice purchasing. | |
| the CosmWasm team for Nameservice purchasing. | |
| You can check out the contract [here](https://github.com/InterWasm/cw-contracts/tree/main/contracts/nameservice). |
pthmas
force-pushed
the
pierrick/remove-deprecated-tutorials
branch
from
d791769 to
cd259be
Compare
pthmas
force-pushed
the
pierrick/remove-deprecated-tutorials
branch
from
cd259be to
fe262a3
Compare
Overview
Remove deprecated tutorials.