Centralized documentation for developers
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- javascript
- Domain
- documentation
Research direction
Start with the developers page and its Getting Started and First App tutorials, then review the linked solid-client setThing documentation. Assess how Solid standards and platform-specific examples are currently organized. Done means the requested centralized documentation scope is defined and includes usable code snippets, example data, and expected outcomes.
Written by the indexing model from the issue text.
Description
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.
- Dominant language
- HTML
- Stars
- 183
- Forks
- 158
- PR merge metrics
- No merged PRs in 30d
Getting set up
- Ships a Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
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.
More from solid/solidproject.org
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
solid/solidproject.org#980 · 13 comments ·
-
Add ImagineOpen
Difficulty 1/5 1-3 hours Newbie friendliness 62/100
solid/solidproject.org#270 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
solid/solidproject.org#968 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 56/100
solid/solidproject.org#959 · 3 comments ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
solid/solidproject.org#958 · 1 comment ·
All issues in solid/solidproject.org
Similar issues
-
📕documentation
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
db-ux-design-system/core-web#8343 ·
Maintainers usually reply within 1 day
-
enhancement triage/needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
heygen-com/hyperframes#4944 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
status:untriaged
Difficulty 1/5 Under an hour Newbie friendliness 92/100
midnightntwrk/midnight-wallet#790 ·
Maintainers usually reply within 1 day
-
component:midnight-toolkit status:untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
midnightntwrk/midnight-node#2237 ·
Maintainers usually reply within 1 day