docs: a documentation site built from docs/

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

メンテナーはふだん 1 日以内に返信

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

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
43/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
github-actions, markdown, typescript, vite

調査の方向性

Start with docs/reference/limitations.md and the existing docs/ structure described in the issue; then inspect the repository’s workspace configuration, README, npm page, and CI workflows. Choose a static generator that renders the Markdown unchanged, and check how doctests and link checks can gate a GitHub Pages deploy from main. Done means the site is deployed, linked from both places, the limitation is removed, and site dependencies are isolated in their own workspace package.

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

説明

area: core

From docs/reference/limitations.md (Alex, 2026-11-13: worth doing soon).

docs/ is now in Diátaxis shape (#265), with every example tested. Publish it as a site.

  • choose a static generator that renders the existing Markdown as is (VitePress or Starlight), with no content changes needed
  • build and deploy to GitHub Pages from main in CI, with the doctests and link checks gating the deploy
  • the README and npm page link to the site; the "No docs site yet" limitation goes
  • a size and dependency note: the site's dependencies are in their own workspace package, never in ducat's
主要言語
TypeScript
スター
0
フォーク
0
平均マージ
35分
マージ済み PR(30日)
242

環境構築

はじめの一歩

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

public/ducat のほかの issue

public/ducat の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

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

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