docs: add a README to @relkit/client

Aperta Adatta ai principianti
#177 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
79/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
bun, typescript
Ambito
documentation

Direzione di ricerca

Leggi WRITING.md ed esamina i file esistenti del pacchetto client per capire il client tipizzato e la struttura del suo riferimento API. Aggiungi packages/client/README.md con una breve spiegazione, un esempio di api.orders.list e link alla guida del client su relkit.dev. Esegui bun run check; il lavoro è terminato quando il controllo passa e qualsiasi esempio aggiunto a una pagina della documentazione supera il controllo dei tipi.

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

Descrizione

documentation good first issue

packages/client has no README.md, so its npm page is empty.

What to do

  • Add packages/client/README.md: what the typed client is, one short example of calling an API
    reference such as api.orders.list, and links to the client guide on https://relkit.dev.
  • Follow WRITING.md (plain language, one product name).

Done when bun run check passes and the example type-checks if you add it to a docs page too.

Lingua principale
TypeScript
Stelle
1
Fork
0
Merge medio
2h 45m
PR unite (30g)
64

Preparare l'ambiente

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 rel-kit/relkit

Tutte le issue di rel-kit/relkit

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.