docs(phase-4): add docs-code consistency tests and final polish

オープン
  • 何か問題がありますか？
#229 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
48/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
静か
技術スタック
markdown, python
領域
documentation, testing, tooling

調査の方向性

まずフェーズの依存関係と既存の CLI テストを読み、次にドキュメントのソース、llmstxt 設定、Makefile のターゲット、現在の llms.txt ファイルを確認します。一覧にある整合性チェックとリンクチェック用に tests/cli/test_docs.py を追加し、両方の LLM ファイルを再生成して検証し、make format と make quality を実行して、CI がグリーンでフォーマットまたは品質の失敗がない状態でレビューを完了します。

索引モデルが issue の本文から書いたものです。

説明

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.txt regenerated and LLM-verified
  • Zero mdformat/quality failures
主要言語
Python
スター
79
フォーク
23
30日以内にマージされた PR はありません

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

coder/balatrobot のほかの issue

coder/balatrobot の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。