solid / solid/solid-oidc

It would be helpful to have introduction to flows in primer

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

Nobody has claimed this yet.

primer
Dominant language
Bikeshed
Stars
26
Forks
14
PR merge metrics
No merged PRs in 30d

Description

The published primer contains 2 flows. But there is no introduction as to when they are needed and why. A short paragraph or two doing that would help make the structure easier to read and understand for people coming at it for the first time.

Contributor guide

No contributing guide indexed for this repository

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 with the published primer at https://solid.github.io/authentication-panel/solid-oidc-primer/ and locate the source document that generates it. Read the existing two flow sections and add a short explanation of when each flow is needed and why, then verify the published primer's structure and wording.

Written by the indexing model from the issue text.

Assessment

Domain
authentication, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.