Skip to content

fix: learn links #584

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 9, 2025
Merged

fix: learn links #584

merged 1 commit into from
Jul 9, 2025

Conversation

pthmas
Copy link
Contributor

@pthmas pthmas commented Jul 9, 2025

Overview

Since I merged the intro and overview pages, the links were no longer valid. This PR fixes the links.

Summary by CodeRabbit

  • Documentation
    • Updated navigation and internal links to direct users from "/learn/intro" to "/learn/about" in the menu and main page sections.

Copy link
Contributor

coderabbitai bot commented Jul 9, 2025

Walkthrough

The changes update navigation and internal documentation links by replacing references to "/learn/intro" with "/learn/about" in both the site configuration and the main documentation index. No other structural or content modifications are introduced.

Changes

Files Change Summary
.vitepress/config.ts Updated "Learn" menu item link from "/learn/intro" to "/learn/about"; replaced nested "Overview" sidebar group with a direct "About Rollkit" link.
index.md Changed two internal links from "/learn/intro" to "/learn/about".

Possibly related PRs

Suggested reviewers

  • Manav-Aggarwal
  • tuxcanfly
  • gupadhyaya
  • tac0turtle

Poem

A hop, a skip, a link anew,
From "intro" to "about" we flew.
Navigation clear and bright,
Docs now guide you just right.
With every change, we leap ahead—
🐇 A rabbit’s work, well-read!


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f04f66b and e3e4c75.

📒 Files selected for processing (2)
  • .vitepress/config.ts (2 hunks)
  • index.md (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • index.md
  • .vitepress/config.ts
✨ Finishing Touches
  • 📝 Generate Docstrings

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@pthmas pthmas changed the title fix: learn page fix: learn links Jul 9, 2025
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 addresses broken links on the 'learn' page and the main homepage. Following a previous merge that consolidated 'intro' and 'overview' content, the hardcoded links were no longer valid. My changes ensure that all relevant links now correctly point to the /learn/overview page, restoring proper navigation and content access.

Highlights

  • Navigation Link Update: I've updated the 'Learn' link in the main navigation bar to point to /learn/overview instead of /learn/intro.
  • Homepage Content Link Correction: I've corrected two instances of the 'Introduction' link on the homepage (index.md) to now point to /learn/overview.
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

  1. 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.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request addresses broken links by replacing the outdated /learn/intro path with /learn/overview. The changes are applied consistently in the VitePress navigation configuration (.vitepress/config.ts) and the main marketing page (index.md). The modifications are straightforward and correctly implement the described fix. The changes look good and I have no further suggestions.

Copy link
Contributor

github-actions bot commented Jul 9, 2025

PR Preview Action v1.6.2
Preview removed because the pull request was closed.
2025-07-09 10:32 UTC

@pthmas pthmas force-pushed the pierrick/fix-first-page branch from 7f9042e to f04f66b Compare July 9, 2025 10:03
@pthmas pthmas marked this pull request as ready for review July 9, 2025 10:16
@pthmas pthmas requested review from alpe, tac0turtle and julienrbrt and removed request for tuxcanfly, tzdybal and jcstein July 9, 2025 10:16
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
index.md (1)

14-20: Button text vs. target mismatch

Now that the target page is “About”, consider renaming the button label from “Introduction” to “About” for consistency and to avoid user confusion.

-      text: Introduction
+      text: About
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between aa15e95 and f04f66b.

📒 Files selected for processing (2)
  • .vitepress/config.ts (1 hunks)
  • index.md (2 hunks)
🔇 Additional comments (2)
.vitepress/config.ts (1)

172-178: No leftover /learn/intro links found
Ran rg -n "/learn/intro" against the repo and got zero matches. The updated nav entry can be safely merged.

index.md (1)

30-33: Link fix acknowledged

The feature card now routes to a valid page; no further issues spotted.

@pthmas pthmas force-pushed the pierrick/fix-first-page branch from f04f66b to e3e4c75 Compare July 9, 2025 10:19
@tac0turtle tac0turtle merged commit 2f99650 into main Jul 9, 2025
7 checks passed
@tac0turtle tac0turtle deleted the pierrick/fix-first-page branch July 9, 2025 10:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants