Skip to content

Update README to include samples link #78

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

Open
jstjoe wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README to include samples link #78

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions profile/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
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
Copy Markdown

@coderabbitai coderabbitai bot Jan 30, 2026

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.


### Additional tools

Expand Down