Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Centralized documentation for developers #757

Open
Shawn-sudo opened this issue Jan 16, 2023 · 0 comments
Open

Centralized documentation for developers #757

Shawn-sudo opened this issue Jan 16, 2023 · 0 comments

Comments

@Shawn-sudo
Copy link

Shawn-sudo commented Jan 16, 2023

Search terms I've used
#492 : I agree with him, but nobody cared
#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 pageBuilding 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant