Serve per-page Markdown for docs and split llms-full.txt by section

オープン
#238 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
54/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
javascript, react
領域
documentation

調査の方向性

Start by locating how the website serves documentation pages and generates or publishes llms.txt and llms-full.txt; the issue does not name specific files or tests. Check how existing docs routes and generated text files are built, then verify that every page has a working .md URL with the correct content type, llms.txt links to those URLs, and llms-full.txt is split by section.

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

説明

Summary

There are no per-page Markdown URLs. AI tools must either parse HTML or download the whole 718 KB llms-full.txt to read a single docs page.

Current behavior

  • /docs/<page>.md does not exist.
  • llms-full.txt is one 718 KB file.

Proposed solution

  1. Serve a Markdown version of every docs page at /docs/<page>.md.
  2. Link those .md URLs from llms.txt.
  3. Split llms-full.txt by section (for example llms-full-advanced-guide.txt, llms-full-guides.txt) and link them from llms.txt.

Acceptance criteria

  • Every docs page has a working .md URL with correct content type.
  • llms.txt links to the .md versions.
  • llms-full.txt is split by section.

Why this matters

Small, per-page Markdown cuts token cost and parsing errors for AI tools and coding assistants, and makes answers more accurate.

Additional context

Found in an audit of gofr.dev AI readiness and discoverability on 2026-10-07. Nice-to-have; lower priority than the llms.txt coverage issue.

主要言語
JavaScript
スター
44
フォーク
44
PR マージ指標
30日以内にマージされた PR はありません

環境構築

  • Dockerfile または Docker Compose ファイルあり
  • プルリクエストのテンプレートなし
  • コントリビューションガイドなし

はじめの一歩

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

gofr-dev/website のほかの issue

gofr-dev/website の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

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

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