jprdonnelly/core
1
0
Fork 0
mirror of synced 2025-12-19 18:06:02 -05:00
Code Issues Projects Releases Wiki Activity

Align reference.md with llms.txt updates

Browse Source 
- Entry Points table: "Version/patch" → "Single-version", "Time-based" → "Time-range"
- Month Index schema: added prev-security link to show year-boundary crossing
- Added traversal example for "CVEs since September 2024"
- Added expected fetch counts for self-assessment

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Richard Lander
2025-12-08 16:08:14 -08:00
parent d58db9fc08
commit 7f62ce0dfe
1 changed files with 24 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
llms/reference.md
View File

@@ -8,8 +8,8 @@ For quick reference, see [llms.txt](https://raw.githubusercontent.com/dotnet/cor
| Query Type | Entry Point |
|------------|-------------|
| Version/patch queries | `https://raw.githubusercontent.com/dotnet/core/refs/heads/release-index/release-notes/index.json` |
| Time-based queries | `https://raw.githubusercontent.com/dotnet/core/refs/heads/release-index/release-notes/timeline/index.json` |
| Single-version queries | `https://raw.githubusercontent.com/dotnet/core/refs/heads/release-index/release-notes/index.json` |
| Time-range queries | `https://raw.githubusercontent.com/dotnet/core/refs/heads/release-index/release-notes/timeline/index.json` |
**CRITICAL**: Never construct URLs manually. Always follow `_links["..."].href` values from JSON responses.
@@ -256,6 +256,7 @@ Link relation names are self-documenting:
"_links": {
"self": { "href": ".../timeline/2025/01/index.json" },
"prev": { "href": ".../timeline/2024/12/index.json" },
"prev-security": { "href": ".../timeline/2024/11/index.json" },
"cve-json": { "href": ".../timeline/2025/01/cve.json" }
},
"_embedded": {
@@ -501,6 +502,27 @@ The `prev-security` links are pre-computed at publish time and cross year bounda
**Anti-pattern:** Do not fetch year indexes to inspect `_embedded.months[]` and plan fetches manually (this adds fetches and duplicates work the graph already did). The `prev-security` chain already encodes this — follow it instead.
Example traversal for "CVEs since September 2024":
```text
Timeline Index → 2025/index.json
→ latest-security-month → 2025/10 ✓
→ prev-security → 2025/06 ✓
→ prev-security → 2025/04 ✓
→ prev-security → 2025/01 ✓
→ prev-security → 2024/11 ✓ (crosses year boundary)
→ prev-security → 2024/10 ✓
→ prev-security → 2024/08 (before Sept, STOP)
```
**Expected fetch counts** (for self-assessment):
* "Latest patch for .NET X": 2–3 fetches
* "CVEs since [date]": 1 + number of security months in range
* "CVEs for specific patch": 2–3 fetches
If your count significantly exceeds these, you may be navigating inefficiently.
**For specific month queries**, navigate directly:
1. GET `timeline/index.json` → navigate to year → navigate to month