openid / openid/sharedsignals

Align Stream Update Event and Verification event in spec outline

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

Nobody has claimed this yet.

spec:SSF vFuture
Dominant language
Makefile
Stars
78
Forks
18
PR merge metrics
No merged PRs in 30d

Description

The current spec mentions the Stream Updated Event and Verification Event.

The verification event description is contained within the Verification chapter and doesn't explicitly appear in the outline.
The stream updated event appears in the outline. This feels unbalanced.

I propose to move the Stream Updated Event to the Stream Status section to make the outline more consistent.

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

Inspect the source for the OpenID Shared Signals Framework spec outline and the Stream Status and Verification sections. Move the Stream Updated Event entry into the Stream Status section so the outline represents both event descriptions consistently, then verify the rendered outline.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.