solid / solid/solidproject.org

Align "use Solid" with "user guide"

Open
#125 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Content
Dominant language
HTML
Stars
183
Forks
152
PR merge metrics
No merged PRs in 30d

Description

If you read https://solidproject.org/use-solid, it says:

To get started with Solid you will first need a Pod and a WebID, after which you can start using Solid apps.

This is an entirely apps-centered view of the value Solid brings to an end-user.

If you read https://github.com/solid/userguide#introduction, it does mention the existence of apps, but also states that you can use Solid without using apps:

Using the Data Browser, you can coordinate all of your data in an interface that can be configured and extended to support all of your needs on Solid.

It's a partially apps-centered, partially databrowser-centered, view of the value Solid brings to an end-user.

Which one best describes what we're building? Should we align the two?
And maybe we should consolidate the end-user documentation, by moving the content of https://github.com/solid/userguide over to the https://solidproject.org/use-solid/ folder?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the end-user framing in https://solidproject.org/use-solid with the introduction in https://github.com/solid/userguide. Determine whether the documentation should present apps, the Data Browser, or both, then define the intended alignment and whether consolidating the user guide into the use-solid folder is appropriate.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
content, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.