New hover functionality

[Sipher]

Summary by CodeRabbit

• New Features

  • Added a comprehensive "Concepts & Terminology" glossary to the documentation.
  • Introduced a custom tooltip system for enhanced term explanations throughout the docs.
  • Added a new "Tokenomics" explanation for holders.

• Enhancements

  • Improved sidebar navigation structure for easier access to key documentation sections.
  • Updated documentation to use inline tooltips for important terms, improving readability and understanding.
  • Refined "Choose Your Path" and "For Holders" sections for greater clarity and flexibility.

• Style

  • Enhanced link and tooltip styling for better visual consistency and usability.

• Chores

  • Added the astro-tooltips package to support new tooltip features.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This update restructures the documentation sidebar by moving and regrouping entries, introduces a new Head component with integrated tooltips, updates link and tooltip styling, adds a glossary as a new documentation file, and includes the astro-tooltips dependency. Several documentation files are revised for clarity and semantic markup.

Changes

File(s)	Change Summary
astro.config.mjs	Sidebar navigation reorganized; entries moved, removed, or added; new components property registering Head component.
package.json	Added astro-tooltips dependency.
src/components/Head.astro	New Astro component wrapping Starlight's Head and adding tooltip support.
src/content/docs/explanations/concepts-terminology.mdx	New glossary file defining and exporting key Torus concepts and terminology.
src/content/docs/explanations/table-of-contents.mdx	Expanded "For Holders" section; added "Tokenomics" link and updated staking description.
src/content/docs/getting-started/concepts-terminology.mdx	Removed glossary file from "Getting Started" section.
src/content/docs/getting-started/understanding-torus.mdx	Replaced key term text with inline spans referencing imported definitions for semantic clarity.
src/content/docs/index.mdx	Revised "Choose Your Path" section for clarity; added bulleted options and improved navigation guidance.
src/tailwind.css	Added/expanded content link and tooltip styles; detailed customization guides; navigation link exclusions clarified.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HeadComponent
    participant StarlightHead
    participant Tooltips

    User->>HeadComponent: Render Head with props and slot
    HeadComponent->>StarlightHead: Forward props and slot
    HeadComponent->>Tooltips: Render Tooltips (non-interactive, delay, placement)

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~15–20 minutes

Possibly related PRs

• Dev #10: Also updates sidebar navigation and configuration in astro.config.mjs, related to navigation restructuring.
• Dev #11: Changes the same sidebar configuration object, reorganizing documentation navigation structure.
• Finish refactoring folder structure #19: Updates sidebar configuration by reorganizing entries and correcting slugs, overlapping with the scope of this PR.

Poem

In docs we hop, with links anew,
Tooltips glow in yellow hue.
Sidebars shift, new terms defined,
A glossary for every curious mind.
From Head to tailwind, all aligned—
This bunny’s work, both neat and kind!
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 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 ef09aa0 and f250124.

⛔ Files ignored due to path filters (1)

• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (9)

• astro.config.mjs (4 hunks)
• package.json (1 hunks)
• src/components/Head.astro (1 hunks)
• src/content/docs/explanations/concepts-terminology.mdx (1 hunks)
• src/content/docs/explanations/table-of-contents.mdx (1 hunks)
• src/content/docs/getting-started/concepts-terminology.mdx (0 hunks)
• src/content/docs/getting-started/understanding-torus.mdx (1 hunks)
• src/content/docs/index.mdx (1 hunks)
• src/tailwind.css (4 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch dev

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 generate unit tests to generate unit tests for 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.