clean: remove deprecated tutorials #588
Conversation
WalkthroughThis update removes three detailed guide documents related to CosmWasm orchestration, IBC connections, and zkML integration. The sidebar configuration is simplified by eliminating the "Integrations" group and its nested links, leaving only a single direct guide link. References to the deleted guides are also updated in the documentation. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Sidebar
participant Guides
User->>Sidebar: Open "How To Guides"
Sidebar-->>User: Show single direct link (no Integrations group)
User->>Guides: Access guide
Guides-->>User: Serve available guide (other guides deleted)
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (5)
💤 Files with no reviewable changes (3)
🧰 Additional context used🧠 Learnings (3)📓 Common learningstutorials/execution/cosmwasm.md (6).vitepress/config.ts (4)🔇 Additional comments (2)
✨ Finishing Touches
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 (
|
![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 cleaning up and streamlining the project's documentation. The primary goal is to remove outdated or deprecated tutorial content and ensure that the navigation accurately reflects available guides, thereby improving the overall user experience and maintainability of the documentation.
Highlights
- Documentation Navigation Cleanup: Removed several deprecated tutorial links from the main navigation sidebar in
.vitepress/config.ts. Specifically, the 'Integrations' collapsible group was removed, and links to 'Test and deploy cosmwasm smart-contracts', 'Add zkML to your EVM rollup', and 'Add an IBC connection to your rollup' were taken out. The 'Use IBC token (TIA) as gas token in your rollup' link was retained but moved to be a direct sibling of 'Metrics' in the sidebar. - Internal Link Correction: Updated the
tutorials/execution/cosmwasm.mdfile to remove a markdown link to thecw-orchestratorguide, changing it to plain text. This likely addresses a broken or deprecated reference within the tutorial content.
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. ↩
pthmas
force-pushed
the
pierrick/remove-deprecated-tutorials
branch
from
fe262a3 to
732d74d
Compare
|
There was a problem hiding this comment.
Code Review
This pull request removes several deprecated tutorials from the documentation sidebar and updates a link in one of the tutorials. The changes are in line with the goal of cleaning up deprecated content. I have one suggestion to improve a modified line in a markdown file by replacing a removed internal link with an external one to maintain its usefulness for readers. I've also noted an inconsistency where a similar link was not updated in the same file, which could lead to a broken link.
Overview
Remove deprecated tutorials.
Summary by CodeRabbit