docs: add documentation for image preview

[yorukot]

Summary by CodeRabbit

• New Features
  • Added a new "Image Preview" section to the sidebar navigation for easier access.
• Documentation
  • Introduced comprehensive documentation explaining terminal-based image previews, supported protocols, terminal compatibility, and fallback mechanisms.

[coderabbitai]

Walkthrough

A new "Image Preview" documentation page was added to the website, and a corresponding sidebar navigation link was introduced in the "Start Here" section. The documentation details terminal image preview capabilities, supported protocols, terminal compatibility, detection mechanisms, and fallback behavior for the superfile tool.

Changes

File(s)	Change Summary
website/astro.config.mjs	Added "Image Preview" link to the sidebar under "Start Here".
website/src/content/docs/getting-started/image-preview.md	Introduced a new documentation page explaining image preview features, protocol support, and detection.

Poem

In the warren of docs, a new page appears,
"Image Preview" hops in, dispelling old fears.
Terminals now show images—what a neat trick!
With protocols and fallbacks, the previews are slick.
So hop along, dear user, and give it a try,
For even in text, your images fly!
🐇🖼️

✨ 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

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (3)

website/astro.config.mjs (1)

106-109: Ensure trailing comma for consistency in sidebar configuration.

For consistent styling—each array item in this config uses a trailing comma—consider adding a comma after the new sidebar entry’s closing brace:

   {
     label: 'Image Preview',
     link: '/getting-started/image-preview/',
   },

website/src/content/docs/getting-started/image-preview.md (2)

64-66: Specify a language for the code fence.

The fenced block showing the escape sequence lacks a language identifier, which prevents proper syntax highlighting. For example:

- ```
+ ```bash
  \x1b[16t
- ```
+ ```

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

64-64: Fenced code blocks should have a language specified
null

(MD040, fenced-code-language)

---

74-74: Use the verb form “fall back” instead of the noun “fallback”.

Correct the usage from “fallback” (noun) to “fall back” (verb):

- If your terminal does not support `\x1b[16t`, we fallback to default assumptions like `10×20 px per cell`.
+ If your terminal does not support `\x1b[16t`, we fall back to default assumptions like `10×20 px per cell`.

🧰 Tools

🪛 LanguageTool

[grammar] ~74-~74: The word “fallback” is a noun. The verb is spelled with a space.
Context: ...erminal does not support \x1b[16t, we fallback to default assumptions like `10×20 px p...

(NOUN_VERB_CONFUSION)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8cb3d63 and 42ee837.

📒 Files selected for processing (2)

• website/astro.config.mjs (1 hunks)
• website/src/content/docs/getting-started/image-preview.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

website/src/content/docs/getting-started/image-preview.md

[grammar] ~74-~74: The word “fallback” is a noun. The verb is spelled with a space.
Context: ...erminal does not support \x1b[16t, we fallback to default assumptions like `10×20 px p...

(NOUN_VERB_CONFUSION)

🪛 markdownlint-cli2 (0.17.2)

website/src/content/docs/getting-started/image-preview.md

64-64: Fenced code blocks should have a language specified
null

(MD040, fenced-code-language)

⏰ Context from checks skipped due to timeout of 90000ms (4)

• GitHub Check: test
• GitHub Check: Analyze (python)
• GitHub Check: Analyze (javascript-typescript)
• GitHub Check: Analyze (go)