Skip to content

Update README to include samples link#78

Open
jstjoe wants to merge 1 commit intomainfrom
jstjoe-samples
Open

Update README to include samples link#78
jstjoe wants to merge 1 commit intomainfrom
jstjoe-samples

Conversation

@jstjoe
Copy link
Contributor

@jstjoe jstjoe commented Jan 30, 2026

Added a link to sample docs and tests for getting started.

Summary by CodeRabbit

  • Documentation
    • Enhanced documentation by updating reference links to better serve users seeking practical examples and guidance. The updated references now point directly to sample resources, making it easier for users to discover and access hands-on examples and reference materials.

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

Added a link to sample docs and tests for getting started.
@coderabbitai
Copy link

coderabbitai bot commented Jan 30, 2026

Walkthrough

A single line in the profile README file is updated, replacing a doc-detective reference link with a samples reference link. The change involves no code modifications.

Changes

Cohort / File(s) Summary
Documentation Update
profile/README.md
Replaced doc-detective link with samples link reference.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~1 minute

Possibly related PRs

Suggested reviewers

  • hawkeyexl

Poem

🐰 A carrot-filled link hops away with grace,
Samples now guide the way to this place,
README updated, shiny and new,
One little change, much cleaner too! ✨

🚥 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 'Update README to include samples link' accurately reflects the main change in the pull request: adding a samples link to the README file.
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 unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch jstjoe-samples

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.

@jstjoe jstjoe requested a review from hawkeyexl January 30, 2026 03:35
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@profile/README.md`:
- Line 9: Update the link text that currently reads "/samples" to "samples" in
the README (replace the leading slash in the link label '/samples' so it matches
other link labels like 'doc-detective', 'github-action', 'common', 'core',
'resolver'); ensure the URL stays unchanged and only the visible link text is
modified.

Doc Detective is a doc content testing framework that simplifies the process of keeping your docs accurate and up-to-date. You write tests, and Doc Detective runs them directly against your product to ensure your docs match your user experience. Whether it’s a UI-based process or a series of API calls, Doc Detective can help you find doc bugs before your users do.

- [doc-detective](https://github.com/doc-detective/doc-detective): The `doc-detective` command line interface for creating and running documentation tests.
- [/samples](https://github.com/doc-detective/doc-detective/tree/main/samples): Sample docs and tests for getting started.
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Link text inconsistency: Remove the leading slash.

The link text /samples uses a leading slash, which is inconsistent with other links in this document (e.g., doc-detective, github-action, common, core, resolver). For consistency, the link text should be samples without the leading slash.

📝 Proposed fix for consistency
-- [/samples](https://github.com/doc-detective/doc-detective/tree/main/samples): Sample docs and tests for getting started.
+- [samples](https://github.com/doc-detective/doc-detective/tree/main/samples): Sample docs and tests for getting started.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- [/samples](https://github.com/doc-detective/doc-detective/tree/main/samples): Sample docs and tests for getting started.
- [samples](https://github.com/doc-detective/doc-detective/tree/main/samples): Sample docs and tests for getting started.
🤖 Prompt for AI Agents
In `@profile/README.md` at line 9, Update the link text that currently reads
"/samples" to "samples" in the README (replace the leading slash in the link
label '/samples' so it matches other link labels like 'doc-detective',
'github-action', 'common', 'core', 'resolver'); ensure the URL stays unchanged
and only the visible link text is modified.

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.

2 participants