Add hosted docs
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 25/100
- issue の種類
- ドキュメント
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- python
調査の方向性
まず、既存の VRS-Python ドキュメントとリンク先の Read the Docs の例を確認します。ホストされたサイト向けに、一般ユーザー向けと開発者向けのコンテンツを分けて定義し、その後、作成したドキュメントが提案されたアドレス vrs-python.readthedocs.io で利用でき、両方の対象者をカバーしていることを確認します。
索引モデルが issue の本文から書いたものです。
説明
Feature description
Add hosted HTML docs (on RTD) for technical and general-audience documentation
Use case
Documentation will help both users and developers understand VRS-Python better
Acceptance Criteria
Given I'm a non-technical user,
When I go to vrs-python.readthedocs.io (or something similar),
Then I should see documentation on general info about VRS-Python (I like Beacon's general docs as an example: https://genomebeacons.org/)
Given I'm a developer,
When I go to vrs-python.readthedocs.io (or something similar),
Then I should see technical documentation about VRS-Python (I like Beacon's general docs as an example: https://docs.genomebeacons.org/)
Proposed solution
No response
Alternatives considered
No response
Implementation details
No response
Potential Impact
No response
Additional context
More good examples that @jsstevenson created for some of our projects:
- https://coolseqtool.readthedocs.io/0.13.0/
- https://gene-normalizer.readthedocs.io/latest/
- https://disease-normalizer.readthedocs.io/latest/
- https://fusor.readthedocs.io/0.5.0/
Contribution
None
- 主要言語
- Python
- スター
- 63
- フォーク
- 43
- 平均マージ
- 1時間 2分
- マージ済み PR（30日）
- 1
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
ga4gh/vrs-python のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
ga4gh/vrs-python#653 · リアクション 2 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
ga4gh/vrs-python#540 · コメント 8 件 ·
-
enhancement
ga4gh/vrs-python#651 · コメント 1 件 · 担当者 1 名 ·
-
ga4gh/vrs-python#641 · 担当者 1 名 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
ga4gh/vrs-python#640 ·
ga4gh/vrs-python の issue をすべて見る
似ている issue
-
bug priority:low
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
CyberAgent/psd2svg#436 ·
-
area/install-update comp/cli comp/desktop P3 sweeper:risk-compatibility type/bug
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
NousResearch/hermes-agent#122386 · コメント 1 件 ·
-
ai-generated
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
vllm-project/production-stack#1105 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100