Autogenerate api documentation for the public apis

Aperta
#345 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
20/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
ruby
Ambito
api, documentation

Direzione di ricerca

Start by reviewing the server's public APIs used by clients and the proposed rspec_api_documentation gem. Determine which trivial APIs can be covered and how generated documentation should be published. Done means the selected public APIs have autogenerated documentation that clients can use.

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

Descrizione

enhancement tmc-legacy-course

We should attempt on trying to autogenerate api documentation at least for the trivial APIs used by various clients. This probably should be done with a gem like https://github.com/zipmark/rspec_api_documentation

Lingua principale
Ruby
Stelle
51
Fork
42
Merge medio
1h 27m
PR unite (30g)
1

Guida per i contributori

Apri la guida per i contributori

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 testmycode/tmc-server

Tutte le issue di testmycode/tmc-server

Issue simili

Altre issue su Ruby

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.