Add hosted docs
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 25/100
- Tipo di issue
- Documentazione
- Chiarezza
- Da chiarire
- Stato di attività
- Ferma
- Stack tecnologico
- python
- Ambito
- documentation
Direzione di ricerca
Esamina innanzitutto la documentazione esistente di VRS-Python e gli esempi collegati di Read the Docs. Definisci contenuti separati per il pubblico generale e per gli sviluppatori per il sito ospitato, quindi verifica che la documentazione risultante sia disponibile all’indirizzo proposto vrs-python.readthedocs.io e copra entrambi i pubblici.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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
- Lingua principale
- Python
- Stelle
- 63
- Fork
- 43
- Merge medio
- 1h 2m
- PR unite (30g)
- 1
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di ga4gh/vrs-python
-
Update to `pysam>=0.24.0` Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
ga4gh/vrs-python#653 · 2 reazioni ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
ga4gh/vrs-python#540 · 8 commenti ·
-
enhancement
ga4gh/vrs-python#651 · 1 commento · 1 assegnatario ·
-
ga4gh/vrs-python#641 · 1 assegnatario ·
-
Add Adjacency Normalization Aperta
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
ga4gh/vrs-python#640 ·
Tutte le issue di ga4gh/vrs-python
Issue simili
-
agent-ready documentation needs-triage
Difficoltà 1/5 1-3 ore Idoneità per principianti 88/100
-
documentation
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 91/100
-
workflow-status page template still says reusable workflows are "triggered only by workflow_call:" Aperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 92/100
-
instance instance add
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 72/100
searxng/searx-instances#939 · 1 commento ·
-
area-deployment area-integrations triage:bot-seen
Difficoltà 2/5 Mezza giornata Idoneità per principianti 86/100