Add an integrated documentation website

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

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

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
typescript

調査の方向性

まずリポジトリの構成と既存の TypeScript パッケージワークフローを確認し、統合されたドキュメントサイトをどこに組み込めるかを判断します。実装前に、デプロイ方法、Markdown とコードスニペットのサポート、拡張モデル、ランディングページの範囲を定義してください。fork からパッケージ用のドキュメントサイトをデプロイしてカスタマイズできれば完了です。

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

説明

A documentation website baked into the stack so forks can:

  • Deploy it for free
  • Document the open-source package
  • Have a way to support md and code snippets so they can showcase examples
  • Allow easy extension
  • Add cool landing page?
主要言語
TypeScript
スター
121
フォーク
11
PR マージ指標
30日以内にマージされた PR はありません

環境構築

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

はじめの一歩

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

似ている issue

TypeScript の issue をもっと見る

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

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