ProjectTech4DevAI / ProjectTech4DevAI/kaapi-backend
API Documentation: Platform acquisition and migration
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 18
- Fork
- 10
- Merge medio
- 2g 20h
- PR unite (30g)
- 14
Descrizione
Is your feature request related to a problem?
We lack a dedicated API documentation platform. This hinders clear communication and understanding of our APIs, leading to confusion among users.
Describe the solution you'd like
- Acquire a suitable API documentation platform.
- Migrate existing documentation to the new platform.
Original issue
Get a API docs platform and migrate.
Guida per i contributori
Apri 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.
Direzione di ricerca
Inizia facendo un inventario della documentazione API esistente e definendo i requisiti per una piattaforma di documentazione dedicata. Valuta le piattaforme adatte con i maintainer, quindi pianifica l’ambito della migrazione. Il lavoro sarà considerato completato quando sarà stata selezionata una piattaforma e la documentazione API esistente sarà stata migrata al suo interno.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Ambito
- api, documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Tranquilla
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 30/100