solid
Centralized documentation for developers
Search terms I've used https://github.com/solid/solidproject.org/issues/492 : I agree with him, but nobody cared https://github.com/solid/solidproject.org/issues/649 : somewhat related
Is your feature request related to a problem? Please describe.
-
The current documentation doesn't provide specific info about how to use Solid standards.
-
For example, to learn how to "set thing" with Solid, I start at Get Started page → Building first app page → scroll to the very bottom → luckily found a reference to "solid-client API" → somehow find the documentation of setThing in a website named Inrupt → learn what
setThing()is -
At the Inrupt website (ig this is made for maintainers rather than general developers), I can only learn that
setThing()sets a thing in the dataset. I hope I can see example code snippets & example data to deal with & example outcomes of running the example code, which would let me know if I'm going on the right track.
-
Possible Solution
A centralized documentation describing each feature of the Solid standards, and example code snippets in every platform of how to use those.
Similar case: AppWrite, which is a community-driven backend provider, has very neat documentations. With this documentation, the developers can easily know if they're on the right track.
- I saw a video of a guy explaining how the documentations there are so neat, in which we can see how important docs are in developing experiences.
Describe alternatives you've considered Nothing.
Additional context I really love the idea of Solid. I'm just sad that it's way too difficult to find resources for a newbie like me.
