Add documentation for exposed types
I maintainer di solito rispondono entro 1 giorno
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
- typescript
- Ambito
- documentation
Direzione di ricerca
Inizia esaminando i tipi e le interfacce TypeScript esportati, quindi confronta le opzioni di generazione della documentazione menzionate nell’issue: TypeDoc, typegen e api-extractor. Il lavoro è completato quando per i tipi esposti viene generata una documentazione destinata agli utenti e l’approccio scelto è integrato nel progetto.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Is your feature request related to a problem? Please describe.
There is absolutely no user-facing documentation for any of the exposed types/interfaces.
Describe the solution you'd like
Autogeneration of documentation from the exported types would be nice.
Describe alternatives you've considered
A simple web search turns up a few options, such as this or this. Additionally, api-extractor, which I've looked into using for other reasons, can do this as well.
- Lingua principale
- TypeScript
- Stelle
- 439
- Fork
- 61
- Merge medio
- 4g 3h
- PR unite (30g)
- 16
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
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 StackExchange/Stacks-Editor
-
enhancement
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
StackExchange/Stacks-Editor#504 · 1 commento · 2 reazioni ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 25/100
StackExchange/Stacks-Editor#395 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
enhancement
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
StackExchange/Stacks-Editor#343 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
Task list supportApertaenhancement
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
StackExchange/Stacks-Editor#272 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
Math formulas supportApertaenhancement
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
StackExchange/Stacks-Editor#250 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di StackExchange/Stacks-Editor
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
rajbos/ai-engineering-fluency#2340 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
community documentation first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 70/100
lingdojo/kana-dojo#31864 · 1 commento · 5 reazioni ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
zenstackhq/zenstack#2873 ·
I maintainer di solito rispondono entro 1 giorno
-
CLI: TUI shows onboarding when the provider's API key is only in the environment (e.g. OPENROUTER_API_KEY)Forse già presa Una pull request collegata a questa issue è aperta o già unita. ApertaCLI
Difficoltà 2/5 1-3 ore Idoneità per principianti 67/100
cline/cline#14923 · 2 commenti ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
paperclipai/paperclip#15490 ·
I maintainer di solito rispondono entro 1 giorno