style: make cmd visible on describe resource doc

[amimart]

Add a prompt marker to the beginning of commands to differentiate from their results in the describe resource page.

I decided to use > as marker but we can ship another.. I didn't check other pages for this need.

[coderabbitai]

Walkthrough

The changes involve formatting command-line instructions within the documentation to enhance clarity. Specifically, example commands now feature a > symbol to visually distinguish them, making it easier for users to identify executable instructions. Minor adjustments to the surrounding text were made to maintain coherence, but no alterations were made to public or exported entities.

Changes

File Path	Change Summary
docs/getting-started/quickstart-guides/describe-resource.mdx	Modified formatting for command-line instructions, adding > symbol for clarity. Minor text adjustments made.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Documentation
    User->>Documentation: View command-line instructions
    Documentation-->>User: Display commands with `>` symbol
    User->>Documentation: Execute commands as instructed

Loading

🐰 In the land of code where the commands play,
A little change brightens the day.
With a > to guide, they hop with glee,
Making it clearer for you and me!
So let’s cheer for the docs, a joyful tune,
For every command, they’ll shine like the moon! 🌙

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @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.

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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 23, 2024 7:52am

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between dafe1fb and 4380d61.

Files selected for processing (1)

• docs/getting-started/quickstart-guides/describe-resource.mdx (2 hunks)

Files skipped from review due to trivial changes (1)

• docs/getting-started/quickstart-guides/describe-resource.mdx

[AnjaMis]

👍

[bot-anik]

Device	URL
desktop	http://localhost:3000/

Device	URL
mobile	http://localhost:3000/

Not what you expected? Are your scores flaky? GitHub runners could be the cause.
Try running on Foo instead

[ccamel]

👍