Skip to content

docs(getting-started): add verify step + troubleshooting link #6013

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

docs(getting-started): add verify step + troubleshooting link #6013

wants to merge 4 commits into from

Conversation

@iitslamaa
Copy link
Contributor

@iitslamaa iitslamaa commented Oct 24, 2025 •
edited
Loading

Adds a short installation verification step to the Getting Started guide and links to the Troubleshooting page for easier access.

Note: the Installation page already includes a verification snippet, but this addition is intentional since many users land directly on the Getting Started page, so repeating the check here helps reduce confusion and makes troubleshooting more discoverable.

@iitslamaa
Add installation verification section
6738160 
Added installation verification steps to the getting started guide.
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 24, 2025 •
edited
Loading

📝 Walkthrough

Walkthrough

A new "Verify installation" section is added to the getting-started documentation that appears before the existing setup steps. This section contains instructions for printing version information and eval usage, includes a reference to troubleshooting resources, and maintains the original workflow for setting up the first config file.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

This is a single-file documentation change with straightforward additions. The review requires verification of instruction accuracy, confirmation that the new section placement makes logical sense within the getting-started flow, and a check that the troubleshooting link is appropriate and functional.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The pull request title "docs(getting-started): add verify step + troubleshooting link" is directly related to the changeset. It accurately summarizes the main modifications: the introduction of a "Verify installation" section and the addition of a troubleshooting link to the getting-started documentation. The title is concise, specific, and clearly communicates the primary change without being vague or misleading.
Description Check ✅ Passed The pull request description directly relates to the changeset and accurately describes the modifications. The author states that the change "adds a short installation verification step to the Getting Started guide and links to the Troubleshooting page," which aligns with the raw summary showing a new "Verify installation" section and troubleshooting link added to site/docs/getting-started.md. The description is sufficiently specific and includes helpful context explaining the rationale for repeating the verification step despite it existing elsewhere in the documentation. The description is clearly on-topic and conveys meaningful information about the changes.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

iitslamaa
iitslamaa commented Oct 24, 2025
View reviewed changes
Copy link
Contributor Author

@iitslamaa iitslamaa left a comment

Choose a reason for hiding this comment

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

Updated to satisfy Prettier formatting.

@iitslamaa
Update getting-started.md with installation verification to satisfy P…
5e4ad36 
…rettier

Added instructions to verify installation of promptfoo.
iitslamaa
iitslamaa commented Oct 24, 2025
View reviewed changes
Copy link
Contributor Author

@iitslamaa iitslamaa left a comment

Choose a reason for hiding this comment

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

Updated to satisfy Prettier requirements by including adequate spacing around each code block.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@iitslamaa