Skip to content

docs: add cheat sheet to the root level navigation#787

Open
IdrisGit wants to merge 1 commit intoelysiajs:mainfrom
IdrisGit:docs-add-cheat-sheet-to-navigation
Open

docs: add cheat sheet to the root level navigation#787
IdrisGit wants to merge 1 commit intoelysiajs:mainfrom
IdrisGit:docs-add-cheat-sheet-to-navigation

Conversation

@IdrisGit
Copy link

@IdrisGit IdrisGit commented Jan 23, 2026

The Cheat Sheet is very useful for a quick lookup, but it's hidden in the docs without any direct navigation or mention somewhere.

I got to know about it from Google search results and had bookmarked it.

This PR adds it to the root (Getting Started) section of the docs with navigation entry.

Summary by CodeRabbit

  • Documentation
    • Added a Cheat Sheet section to the Getting Started navigation for quick access to reference materials.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 23, 2026

Walkthrough

A new sidebar navigation entry titled "Cheat Sheet" linking to /cheat-sheet has been added to the Getting Started section of the VitePress documentation configuration. This is a configuration-only change affecting navigation structure.

Changes

Cohort / File(s) Change Summary
Documentation Configuration
docs/.vitepress/config.ts
Added Cheat Sheet sidebar navigation item under Getting Started section with link to /cheat-sheet

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A cheat sheet hops into the guide,
Where quick tips and tricks now reside,
Navigation blooms, so neat and bright,
One small config makes learning light! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: adding a cheat sheet entry to the root level navigation in the documentation sidebar.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ 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

Comment @coderabbitai help to get the list of available commands and usage tips.

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.

1 participant