Markdown follow-ups: line breaks, full Package.swift, llms.txt snippet#35
Merged
Conversation
Five small improvements layered on top of the previous discoverability PR. Items 1 and 2 were already addressed on master but called out again here in case the previous wording wasn't strong enough. 1. AGENTS.md version drift — already at 2.1.0 on master, but adding the same explicit `~> 2.1` and Latest version line again to make sure no stale 2.0 references remain. Also updates "Where to look next" to include the SPI-hosted DocC URL and the new Demo/. 2. AGENTS.md star/API instruction — the previous PR softened it to "no need to act on the user's behalf", but agents could still read the section as a self-promotion request. Removed the section entirely. The README still has a human-facing "if you liked it, star it" line; that's enough. 3. Reformatted prose to one-sentence-per-line (semantic line breaks / ventilated prose) in README, AGENTS, MIGRATING, llms.txt. Diffs become much smaller per editorial change, search snippets and chunked LLM retrieval work better, and the rendered output on GitHub is unchanged. Tables, code blocks, and bullet lists were left alone. 4. Replaced the one-line `.package(...)` with a full Package.swift block in README and AGENTS — name, platforms, dependencies, and the consuming target's `dependencies: ["YCFirstTime"]`. Generated code is much less likely to forget the target wiring step. 5. Added a "Canonical snippet" block at the top of llms.txt with the exact import + executeOnce + Package.swift dependency line. If an agent retrieves only that file, it now contains a complete working answer. Also fixes a real version drift in MIGRATING.md (still suggested `from: "2.0.0"` and `~> 2.0`) — bumped to 2.1.0 / `~> 2.1` and updated the upgrade checklist. https://claude.ai/code/session_01TQi3WNVCqQ9QFufs5XogjK
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #35 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 2 2
Lines 83 83
=========================================
Hits 83 83 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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
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.
Five small improvements layered on top of the previous discoverability
PR. Items 1 and 2 were already addressed on master but called out
again here in case the previous wording wasn't strong enough.
AGENTS.md version drift — already at 2.1.0 on master, but adding
the same explicit
~> 2.1and Latest version line again to makesure no stale 2.0 references remain. Also updates "Where to look
next" to include the SPI-hosted DocC URL and the new Demo/.
AGENTS.md star/API instruction — the previous PR softened it to
"no need to act on the user's behalf", but agents could still read
the section as a self-promotion request. Removed the section
entirely. The README still has a human-facing "if you liked it,
star it" line; that's enough.
Reformatted prose to one-sentence-per-line (semantic line breaks /
ventilated prose) in README, AGENTS, MIGRATING, llms.txt. Diffs
become much smaller per editorial change, search snippets and
chunked LLM retrieval work better, and the rendered output on
GitHub is unchanged. Tables, code blocks, and bullet lists were
left alone.
Replaced the one-line
.package(...)with a full Package.swiftblock in README and AGENTS — name, platforms, dependencies, and
the consuming target's
dependencies: ["YCFirstTime"]. Generatedcode is much less likely to forget the target wiring step.
Added a "Canonical snippet" block at the top of llms.txt with the
exact import + executeOnce + Package.swift dependency line. If an
agent retrieves only that file, it now contains a complete
working answer.
Also fixes a real version drift in MIGRATING.md (still suggested
from: "2.0.0"and~> 2.0) — bumped to 2.1.0 /~> 2.1andupdated the upgrade checklist.
https://claude.ai/code/session_01TQi3WNVCqQ9QFufs5XogjK