Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Autogenerate API docs

Aperta
#27 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
typescript
Ambito
api, documentation

Direzione di ricerca

Inizia esaminando come viene creata manualmente l’attuale documentazione dell’API e confronta questo processo con make gen in coder/coder. Definisci quali fonti dell’API e quali output generati sarebbero coinvolti; il lavoro è completato quando la documentazione può essere rigenerata in modo affidabile e rimane allineata alle modifiche dell’API.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Our format for API docs is great, but as they are manually created I can see how they can get out of sync quickly when we are making changes. We shouldn't do this before launch, but I wonder how we can autogenerate API docs, kind of like how we do wirth make gen on coder/coder

Lingua principale
TypeScript
Stelle
67
Fork
9
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di coder/backstage-plugins

Tutte le issue di coder/backstage-plugins

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.