docs: add Sourcey-generated llms.txt - #69
Conversation
higagan
left a comment
There was a problem hiding this comment.
Thanks for this — the content is honest and the scope is right (repo-root copy only, deploy is separate). Two things before merge:
1. URLs are pinned to a commit hash. Every link points at 77569bb (v0.3.9). That's stable but frozen — when 0.4.0 ships, the llms.txt will still point at 0.3.9's README. Two options:
- Switch to
mainURLs (always current, but can shift if a file moves) - Keep the pin and regenerate llms.txt as part of the release checklist
I'd lean toward main — the file is short enough that a broken anchor is a one-line fix, and a stale llms.txt is worse than a occasionally-shifted link.
2. The summary line is dense. The blockquote crams the description, install command, PyPI link, and scanner link into one paragraph. The llms.txt convention prefers a short one-liner, then structured sections. Something like:
> Runtime guardrails for AI agents at the tool-call execution layer. `pip install modelfuzz`.
The detail belongs in the section links below, not the summary.
Minor: the Sourcey provenance metadata (SHA-256 hashes, generation contract) in the PR body is thorough but doesn't need to ship in the file or the commit message — it's useful for review, not for the reader.
Happy to merge once the URLs are sorted.
Signed-off-by: Nika Greenberg <110728128+Arinbus@users.noreply.github.com>
|
Both requested changes are addressed in |
higagan
left a comment
There was a problem hiding this comment.
Clean, well-scoped docs addition — the descriptions accurately reflect the source files. One change I'll make on top: swap the six github.com/.../blob/main/... links for raw.githubusercontent.com/.../main/... so agents fetch plain text instead of GitHub HTML. Approving as-is and applying that swap myself.
GitHub blob URLs render HTML; raw URLs serve plain text, which is what agents consuming llms.txt actually want. Drops the README.md#red-team-scanner anchor since raw markdown has no anchors.
Summary
llms.txtgenerated with Sourcey3.6.5from audited ModelFuzz source at commit77569bbdd3b61f7226d5447c9f8f61b6b16375e0main-branch pointers covering the README, assistant guide, scanner, contribution policy, security policy, and changelogPer the maintainer reply in #57, this PR deliberately adds the content only. The separate site source can serve the merged file at
/llms.txtastext/plain.Generation provenance
Sourcey generated the heading, summary, section, titles, descriptions, and ordering from deterministic wrappers around the audited commit-pinned repository files. Two independent builds were byte-identical. Because the project will deploy only
/llms.txtrather than Sourcey's companion HTML pages, the finalizer replaces only the six generated site-local hrefs with current first-partymainURLs, as requested in review.3.6.577c93d9f692871528a9cd6addcd9d5d4d645e43570cba949c5057ed6f716143cbc2bcdd6a6327f5caacb608d77198cd63598447ec01e675aaa57a43e191d5662AI assistance and deterministic tooling were used for preparation and verification; the final one-file diff was checked against the maintainer's two requested changes.
Test plan
5 passed110 passedruff check .mypy srcCloses #57