Document the fact that solid-ui deals with data discovery
Nessuno ha ancora preso questa issue.
- Lingua principale
- TypeScript
- Stelle
- 153
- Fork
- 46
- Merge medio
- 1g 8h
- PR unite (30g)
- 7
Descrizione
After reading https://github.com/solid/solid-ui#solid-ui I thought solid-ui was a collection of widgets, plus a form system. But TIL it also implements https://github.com/solid/solid/blob/master/proposals/data-discovery.md
UI.authn.findAppInstances: https://github.com/solid/solid-ui/blob/master/src/authn/authn.ts#L455
registerInTypeIndex: https://github.com/solid/solid-ui/blob/master/src/authn/authn.ts#L531
newAppInstance: https://github.com/solid/solid-ui/blob/master/src/authn/authn.ts#L1374
I'll write some documentation about this somewhere! Hopefully that way others can reuse it to build more cool stuff.
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
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 dal README di solid-ui e dalla proposta data-discovery collegata, quindi leggi le funzioni indicate in src/authn/authn.ts: findAppInstances, registerInTypeIndex e newAppInstance. Documenta che solid-ui implementa data discovery e spiega come questi punti di ingresso supportano il riutilizzo; il lavoro sarà considerato concluso quando il README o un altro luogo adatto della documentazione descriverà chiaramente questa capacità.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- typescript
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100