docs: overhaul README to clarify wrapper nature and add telemetry disclosure#28
Merged
docs: overhaul README to clarify wrapper nature and add telemetry disclosure#28
Conversation
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Michael <michael.l.dangelo@gmail.com>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Michael <michael.l.dangelo@gmail.com>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Michael <michael.l.dangelo@gmail.com>
…closure - Reframe repo as a thin pip wrapper pointing to promptfoo/promptfoo as the source of truth for all features and documentation - Add telemetry disclosure section documenting what is collected, where it goes, and how to disable it (PROMPTFOO_DISABLE_TELEMETRY=1) - Update version pinning docs now that PROMPTFOO_VERSION is implemented - Simplify structure: less marketing copy, more actionable guidance - Direct users to the main project for features/bugs Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
mldangelo
force-pushed
the
docs/readme-overhaul
branch
from
2004443 to
3960402
Compare
- Add telemetry section documenting what is collected and how to opt out (PROMPTFOO_DISABLE_TELEMETRY=1) - Update contributing section to split wrapper issues (here) vs. promptfoo features/bugs (promptfoo/promptfoo) and link to CONTRIBUTING.md - Remove unnecessary version pin from requirements.txt example - Fix bare nodejs.org URL to markdown link Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
4 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
PROMPTFOO_DISABLE_TELEMETRY=1)Test plan