docs(reference-app): restructure the README to lead with seeing and running it - #197
Open
ardetrick wants to merge 2 commits into
Open
docs(reference-app): restructure the README to lead with seeing and running it#197ardetrick wants to merge 2 commits into
ardetrick wants to merge 2 commits into
Conversation
Shows the consent screen as a single hero image, then tucks the full four-step sequence behind a <details> so the reader can click through it without the section dominating the README. Uses the existing stills — no gif or video.
ardetrick
force-pushed
the
docs/reference-app-readme-inversion
branch
from
July 26, 2026 20:56
88a4c8e to
a412b8b
Compare
ardetrick
changed the title
ardetrick
force-pushed
the
docs/reference-app-readme-inversion
branch
from
July 26, 2026 21:08
a412b8b to
e888405
Compare
…unning it Reworks the README onto a community-standard spine (Standard Readme / Make a README): badges + one-line description, what this is, Example flow, Running (requirements, command, then what it loads), Testing (framed as a pattern worth copying), OpenID Connect, and Reference. Cuts the OAuth-101 explanation and the code-to-test navigation table, refreshes the OIDC example, drops the dev task list, and corrects the docker run example to the Hydra version the project actually uses.
ardetrick
force-pushed
the
docs/reference-app-readme-inversion
branch
from
July 26, 2026 21:18
e888405 to
8a23264
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reworks the README onto a community-standard spine (checked against the Standard Readme spec and Make a README), leading with what a visitor actually wants: see it, run it, trust it.
Structure: badges + one-line description → what this is (with a features list) → Example flow (the walkthrough) → Running (with your own Hydra as a subsection) → Testing (elevated, framed as a reusable pattern) → Reference (OIDC/custom-claims example, technologies, build config).
Also: cuts the OAuth-101 explanation (offloaded to Ory's docs, as the Ory reference itself does) and the code-to-test navigation table (it just restated the package layout); folds prerequisites into Running; refreshes the stale 2022 OIDC example; removes the dev task list; adds a build-status badge.
Deferred deliberately: a Contributing section and a License section. Contributing is owner's-call content; and the repo currently has no LICENSE file, so the License section can't be written until a license is chosen (worth doing — see PR discussion).