Skip to content

docs: clarify safe documentation examples #693

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
zcrab-oai wants to merge 3 commits into
base: main
Choose a base branch
from
+3 −0
Open

docs: clarify safe documentation examples #693

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
307f005
docs: clarify safe documentation examples
zcrab-oai Aug 27, 2026
8a4496f
docs: refine safe example guidance
zcrab-oai Aug 27, 2026
1a446b2
docs: clarify safe public example wording
zcrab-oai Aug 27, 2026
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
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ customer data, and security findings before posting.

Open an issue describing the problem and the workflow you want to support.
Documentation corrections and safe examples are welcome.
Use synthetic examples when documenting expected behavior.
Keep example values fictional and safe to share.
Do not include credentials or private information in examples.

## Report a security issue

Expand Down