mirror of
https://github.com/Astro-Han/karpathy-llm-wiki.git
synced 2026-09-14 19:09:17 +08:00
fix: close contract gaps between skill, templates, and examples
- The invariant now states honestly that the script checks the high-signal literal subset; compile-time locate-before-write covers the rest. - See Also links get a single authority: internal-links rules no longer cover them, and their own rule handles rename-fix, removal, and ambiguity reporting. - Malformed Status judgment matches the template: only Outdated requires a date. - Articles gain a required Updated metadata field, closing the loop with cascade rules that refresh it and giving lint a mechanical cross-check for index Updated dates (new auto-fix rule). - Examples align with current schemas: Sources plural, Published in raw, Updated in article and index.
This commit is contained in:
Yuhan Lei
@@ -38,7 +38,7 @@ If Query or Lint cannot find the wiki structure, tell the user: "Run an ingest f
|
||||
|
||||
## The Grounding Invariant
|
||||
|
||||
Every load-bearing fact in wiki/ — numbers, dates, direct quotes — exists verbatim in the raw/ files linked by that article's Raw field. Compile *establishes* this invariant (locate before you write); lint *verifies* it (`scripts/check_evidence.py` greps each fact in the linked raws). Because raw/ is immutable, a verified article stays verified; the script re-checks the whole wiki in seconds, so there is no incremental state to maintain.
|
||||
Every load-bearing fact in wiki/ — numbers, dates, direct quotes — exists verbatim in the raw/ files linked by that article's Raw field. Compile *establishes* this invariant (locate before you write); lint *verifies* it (`scripts/check_evidence.py` greps the high-signal literals — suffixed or large numbers, decimals, ISO dates, longer quotes — in the linked raws; the compile-time locate-before-write rule covers the rest). Because raw/ is immutable, a verified article stays verified; the script re-checks the whole wiki in seconds, so there is no incremental state to maintain.
|
||||
|
||||
---
|
||||
|
||||
@@ -170,8 +170,9 @@ Fix these automatically:
|
||||
**Index consistency** — compare `wiki/index.md` against actual wiki/ files (excluding index.md and log.md):
|
||||
- File exists but missing from index → add entry with `(no summary)` placeholder. For Updated, use the article's metadata Updated date if present; otherwise fall back to file's last modified date.
|
||||
- Index entry points to nonexistent file → mark as `[MISSING]` in the index. Do not delete the entry; let the user decide.
|
||||
- Index entry's Updated differs from the article's metadata Updated → update the index entry to match the article.
|
||||
|
||||
**Internal links** — for every markdown link in wiki/ article files (body text and Sources metadata), excluding Raw field links (validated by Raw references below) and excluding index.md/log.md (handled above):
|
||||
**Internal links** — for every markdown link in wiki/ article files (body text and Sources metadata), excluding Raw field links (validated by Raw references below), excluding See Also section links (handled by the See Also rule below), and excluding index.md/log.md (handled above):
|
||||
- Target does not exist → search wiki/ for a file with the same name elsewhere.
|
||||
- Exactly one match → fix the path.
|
||||
- Zero or multiple matches → report to the user.
|
||||
@@ -182,7 +183,10 @@ Fix these automatically:
|
||||
- Zero or multiple matches → report to the user.
|
||||
|
||||
**See Also** — within each topic directory:
|
||||
- Remove links to deleted files.
|
||||
- Target of a See Also link does not exist → search wiki/ for a file with the same name elsewhere.
|
||||
- Exactly one match → fix the path.
|
||||
- Zero matches → remove the link (a dead cross-reference is not load-bearing).
|
||||
- Multiple matches → report to the user.
|
||||
|
||||
### Mechanical Reports (no fixes)
|
||||
|
||||
@@ -202,7 +206,7 @@ These rely on your judgment. Report findings without auto-fixing:
|
||||
- Outdated claims superseded by newer sources but still presented without a Status block
|
||||
- Missing conflict annotations where sources disagree
|
||||
- Obviously missing cross-references between related articles (suggest them; do not add silently)
|
||||
- Malformed Status blocks (missing date or explanation; format reference: `references/article-template.md`)
|
||||
- Malformed Status blocks (Outdated missing its date, or either block missing its explanation; format reference: `references/article-template.md`)
|
||||
- Orphan pages with no inbound links from other wiki articles
|
||||
- Missing cross-topic references
|
||||
- Concepts frequently mentioned but lacking a dedicated page
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
|
||||
> Source: claude-pace project research
|
||||
> Collected: 2026-03-19 (market data as of 2026-03-19, GitHub stars verified via gh api)
|
||||
> Published: Unknown
|
||||
|
||||
## Competitive Landscape
|
||||
|
||||
|
||||
+1
-1
@@ -8,7 +8,7 @@ This directory contains real files from a knowledge base maintained with `karpat
|
||||
|------|---------------|
|
||||
| `claude-code-statusline-landscape.md` | Compiled wiki article with structured data (tables, citations, cross-references) |
|
||||
| `2026-03-19-claude-code-statusline-landscape.md` | Raw source material before compilation |
|
||||
| `ai-coding-tools-index.md` | Topic index with one-line summaries |
|
||||
| `ai-coding-tools-index.md` | One topic section of the global index (summary + Updated per article) |
|
||||
| `log-sample.md` | Sample entries from operation log (all current entry types) |
|
||||
|
||||
## Raw vs Compiled Comparison
|
||||
|
||||
@@ -4,12 +4,12 @@ Usage strategies, context management, multi-agent orchestration, and human-AI in
|
||||
|
||||
## Articles
|
||||
|
||||
| Article | Summary |
|
||||
|---------|---------|
|
||||
| [Claude Max Quota Mechanism](claude-max-quota-mechanism.md) | Dual quota mechanism (5h window + 7d weekly limit) deduction logic and optimization directions |
|
||||
| [AI as GitHub Co-author Status](ai-coauthor-github.md) | Co-authored-by community controversy, legal implications, and tiered strategy recommendations |
|
||||
| [Skill Language Choice and Distribution](skill-language-distribution.md) | Why SKILL.md must be English for skill distribution - ecosystem and technical reasons |
|
||||
| [LLM Working Language Strategy](llm-working-language-strategy.md) | Bilingual developer's language choice: English for system content, Chinese for conversation - practical bilingual strategy, token savings overstated, agentic stability is the real reason |
|
||||
| Article | Summary | Updated |
|
||||
|---------|---------|---------|
|
||||
| [Claude Max Quota Mechanism](claude-max-quota-mechanism.md) | Dual quota mechanism (5h window + 7d weekly limit) deduction logic and optimization directions | 2026-04-02 |
|
||||
| [AI as GitHub Co-author Status](ai-coauthor-github.md) | Co-authored-by community controversy, legal implications, and tiered strategy recommendations | 2026-03-28 |
|
||||
| [Skill Language Choice and Distribution](skill-language-distribution.md) | Why SKILL.md must be English for skill distribution - ecosystem and technical reasons | 2026-04-05 |
|
||||
| [LLM Working Language Strategy](llm-working-language-strategy.md) | Bilingual developer's language choice: English for system content, Chinese for conversation - practical bilingual strategy, token savings overstated, agentic stability is the real reason | 2026-03-30 |
|
||||
| [Code Explanation for Non-Programmers](code-explanation-for-non-programmers.md) | Four-layer progressive explanation framework and CLAUDE.md task briefing rules |
|
||||
| [Compact Instructions Best Practices](compact-instructions-best-practices.md) | auto-compact mechanism's lost content and information retention priority template |
|
||||
| [Multi-Agent Orchestration Landscape](multi-agent-orchestration-landscape.md) | Five orchestration paradigms comparison, real user behavior patterns (role division not simultaneous coding),赛道新约束, 2026-04-11 IDE paradigm explosion (Paseo/super.engineering/Conductor/Emdash) and僵尸识别 (Vibe Kanban/Plandex) |
|
||||
|
||||
@@ -1,7 +1,8 @@
|
||||
# Claude Code Statusline Tool Ecosystem
|
||||
|
||||
> Source: claude-pace project research, 2026-03-19; 2026-03-24
|
||||
> Sources: claude-pace project research, 2026-03-19; 2026-03-24
|
||||
> Raw: [raw/ai-coding-tools/2026-03-19-claude-code-statusline-landscape.md](../../raw/ai-coding-tools/2026-03-19-claude-code-statusline-landscape.md)
|
||||
> Updated: 2026-03-24
|
||||
|
||||
## Overview
|
||||
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
|
||||
> Sources: {Author1, YYYY-MM-DD; Author2, YYYY-MM-DD}
|
||||
> Raw: [{source1}](../../raw/{topic1}/{filename1}.md); [{source2}](../../raw/{topic2}/{filename2}.md)
|
||||
> Updated: {YYYY-MM-DD — when the article's knowledge content last changed. Set to the creation date initially; refresh only on content changes, not typo or formatting fixes.}
|
||||
|
||||
## Overview
|
||||
|
||||
|
||||
Reference in New Issue
Block a user