Document the fact that solid-ui deals with data discovery
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 153
- Forks
- 46
- Ø Merge
- 1 T. 8 Std.
- Gemergte PRs (30 T.)
- 7
Beschreibung
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.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit der solid-ui README und dem verlinkten data-discovery-Vorschlag und lies anschließend die dort referenzierten Funktionen in src/authn/authn.ts: findAppInstances, registerInTypeIndex und newAppInstance. Dokumentiere, dass solid-ui data discovery implementiert, und erläutere, wie diese Einstiegspunkte die Wiederverwendung unterstützen; als erledigt gilt die Aufgabe, wenn die README oder ein anderer geeigneter Dokumentationsort diese Fähigkeit klar abdeckt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100