docs(phase-4): add docs-code consistency tests and final polish
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 48/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Tranquilla
- Stack tecnologico
- markdown, python
- Ambito
- documentation, testing, tooling
Direzione di ricerca
Inizia leggendo le dipendenze tra le fasi e i test CLI esistenti, quindi esamina le sorgenti della documentazione, la configurazione llmstxt, i target del Makefile e i file llms.txt attuali. Aggiungi tests/cli/test_docs.py per i controlli di coerenza e dei link elencati, rigenera e verifica entrambi i file LLM, esegui make format e make quality e completa la revisione con la CI verde e senza errori di formattazione o di qualità.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Part of #224 — v2 docs rewrite (Diátaxis).
Goal
Drift-proofing + final QA before merge.
Tasks
- Add
tests/cli/test_docs.py(openrpc ↔ api.md, typer ↔ cli.md, config env vars ↔ cli.md, link checker) - Update llmstxt config + regenerate
llms.txt/llms-full.txt; verify with an LLM client - Run
make format+make quality; fix mdformat issues - Full docs review pass: every page read for tone consistency (Diátaxis: no quadrant mixing)
Dependencies
- Blocked by: #226 (Phase 1 — reference), #228 (Phase 3 — how-to)
- Blocks: Phase 5 (ship)
Done when
- CI green with the new docs test
-
llms.txtregenerated and LLM-verified - Zero mdformat/quality failures
- Lingua principale
- Python
- Stelle
- 79
- Fork
- 23
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Nessun modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di coder/balatrobot
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
coder/balatrobot#244 ·
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
coder/balatrobot#243 ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 48/100
coder/balatrobot#235 ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 48/100
coder/balatrobot#234 ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 45/100
coder/balatrobot#233 ·
Tutte le issue di coder/balatrobot
Issue simili
-
New InternshipApertanew_internship
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
-
get_graph warns that the oneway column is missing when no way has a oneway tagForse già presa @HTenkanen l’ha presa oggi. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
cython/cython#8110 · 2 commenti ·
I maintainer di solito rispondono entro 1 giorno
-
fix: security 🔐 style: article/section 📝 system: data-mgmt 🗃️ system: security 🔐 system: software 💻
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
uabrc/uabrc.github.io#1267 ·
-
Link Checker ReportApertaBot Type: Bug Type: Documentation
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
I maintainer di solito rispondono entro 1 giorno