Document the fact that solid-ui deals with data discovery
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 153
- Forks
- 46
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 7
Description
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.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the solid-ui README and the linked data-discovery proposal, then read the referenced functions in src/authn/authn.ts: findAppInstances, registerInTypeIndex, and newAppInstance. Document that solid-ui implements data discovery and explain how these entry points support reuse; done means the README or another suitable documentation location clearly covers this capability.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100