add code flow examples to README

[russelmrcl]

Summary by CodeRabbit

• Documentation
  • Reorganized OAuth2 example docs into anchored, linked tutorial headings for easier navigation.
  • Standardized titles and concise descriptions across OAuth2 tutorials (JWT validation, Authorization Code, Resource Owner Password, Client Credentials, OpenID Connect, Google, GitHub, Implicit).
  • Converted descriptive sentences into clear tutorial headings/descriptions to improve discoverability; no behavior changes.

[coderabbitai]

Walkthrough

Rewrote and reorganized OAuth2 example READMEs: the main OAuth2 index now uses anchored, linked tutorial entries; individual example READMEs (credentials, github, google, implicit, membrane, openid) replaced descriptive sentences with concise tutorial-style headings while preserving links and existing content.

Changes

Cohort / File(s)	Summary
OAuth2 Examples Index distribution/examples/security/oauth2/README.md	Converted standalone section headings into anchored, linked tutorial entries (JWT Token Validation (Azure AD), Resource Owner Password, Authorization Code, Client Credentials, OpenID Connect, Google, GitHub, Implicit Flow) and reorganized navigation text.
Credential Flow Example distribution/examples/security/oauth2/credentials/README.md	Replaced introductory sentence with a tutorial-style header; kept the existing tutorial link.
GitHub OAuth2 Example distribution/examples/security/oauth2/github/README.md	Replaced descriptive sentence with a tutorial header; preserved the existing link.
Google OAuth2 Example distribution/examples/security/oauth2/google/README.md	Replaced descriptive sentence with a tutorial header; preserved the existing link.
Implicit Flow Example distribution/examples/security/oauth2/implicit/README.md	Replaced the introductory sentence with a tutorial header for the OAuth2 implicit flow; link unchanged.
Membrane / OpenID Examples distribution/examples/security/oauth2/membrane/README.md, distribution/examples/security/oauth2/openid/README.md	Replaced descriptive intros with concise tutorial headers (Membrane as auth/resource server; OpenID Connect and discovery); preserved external links and content.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related issues

• Update OAuth2 examples #1620 — Updates README headings and descriptions across the same OAuth2 example directories targeted by this change.

Possibly related PRs

• Example docsadd anchor link in examples #2170 — Modifies example documentation anchors and headings similar to this PR.
• add anchor link in sub examples #2171 — Adjusts README navigation and anchor-linking across distribution/examples.
• update oauth2 examples #2230 — Edits the same OAuth2 example README files (header and wording updates).

Suggested reviewers

• predic8
• christiangoerdes

Poem

🐰 I hopped through headings, snipped and neat,
I turned long lines into titles sweet.
Anchors now point where tutorials dwell,
Links stayed true — I balanced well.
A tiny fix, a doc-bunny's feat.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Title Check	⚠️ Warning	The pull request title "add code flow examples to README" is partially related to the changeset but appears misleading regarding the nature of the changes. The changes consistently involve replacing descriptive sentences with headers and reorganizing documentation structure across multiple OAuth2-related README files (for Password Flow, Authorization Code Flow, Implicit Flow, Google, GitHub, OpenID Connect, and Membrane). The word "add" suggests new content or examples are being introduced, but the actual changes are primarily documentation restructuring and reformatting rather than adding new code flow examples. While OAuth2 code flows are mentioned throughout the changes, the main activity is not adding examples but reorganizing existing documentation with improved structure.	Consider revising the title to more accurately reflect the primary change, such as "restructure OAuth2 tutorial documentation with improved headers" or "reorganize OAuth2 README files with better structure". This would help reviewers understand that the PR is about documentation reorganization and formatting rather than adding new content or examples.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch oauth2-doc

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c10a167 and 7505713.

📒 Files selected for processing (1)

• distribution/examples/security/oauth2/README.md (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• distribution/examples/security/oauth2/README.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Analyze (java)

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[membrane-ci-server]

This pull request needs "/ok-to-test" from an authorized committer.

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 681d6fa and 797824d.

📒 Files selected for processing (7)

• distribution/examples/security/oauth2/README.md (1 hunks)
• distribution/examples/security/oauth2/credentials/README.md (1 hunks)
• distribution/examples/security/oauth2/github/README.md (1 hunks)
• distribution/examples/security/oauth2/google/README.md (1 hunks)
• distribution/examples/security/oauth2/implicit/README.md (1 hunks)
• distribution/examples/security/oauth2/membrane/README.md (1 hunks)
• distribution/examples/security/oauth2/openid/README.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Analyze (java)

🔇 Additional comments (5)

distribution/examples/security/oauth2/implicit/README.md (1)

1-3: Clean header restructuring aligned with new documentation format.

The header update generates the correct anchor #oauth2-implicit-flow that matches the reference in the main OAuth2 README.

distribution/examples/security/oauth2/membrane/README.md (1)

1-3: Well-structured header update with matching anchor reference.

The new header generates the correct anchor #oauth2-authorization-code-flow that aligns with the main README's link target on line 9.

distribution/examples/security/oauth2/openid/README.md (1)

1-3: Header restructuring with correct anchor alignment.

The header generates the matching anchor #oauth2-with-openid-connect referenced in the main README.

distribution/examples/security/oauth2/credentials/README.md (1)

1-3: Well-aligned header restructuring.

The new header generates the correct anchor #oauth2-client-credentials-flow matching the main README's link target on line 12.

distribution/examples/security/oauth2/README.md (1)

3-7: External directory references are valid—no issues found.

Both azure-ad-with-jwts and api directories exist in the expected locations, and the anchor links in lines 3 and 6 correctly point to their corresponding headers:

• Line 3 anchor #jwt-token-validation-against-microsoft's-azure-ad correctly links to the header in azure-ad-with-jwts/README.md
• Line 6 anchor #protecting-an-api-with-oauth2-using-the-resource-owner-password-flow correctly links to the header in api/README.md

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 797824d and 9e8ac69.

📒 Files selected for processing (7)

• distribution/examples/security/oauth2/README.md (1 hunks)
• distribution/examples/security/oauth2/credentials/README.md (1 hunks)
• distribution/examples/security/oauth2/github/README.md (1 hunks)
• distribution/examples/security/oauth2/google/README.md (1 hunks)
• distribution/examples/security/oauth2/implicit/README.md (1 hunks)
• distribution/examples/security/oauth2/membrane/README.md (1 hunks)
• distribution/examples/security/oauth2/openid/README.md (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• distribution/examples/security/oauth2/github/README.md

🚧 Files skipped from review as they are similar to previous changes (2)

• distribution/examples/security/oauth2/membrane/README.md
• distribution/examples/security/oauth2/google/README.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Analyze (java)

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8b5cc92 and c10a167.

📒 Files selected for processing (7)

• distribution/examples/security/oauth2/README.md (1 hunks)
• distribution/examples/security/oauth2/credentials/README.md (1 hunks)
• distribution/examples/security/oauth2/github/README.md (1 hunks)
• distribution/examples/security/oauth2/google/README.md (1 hunks)
• distribution/examples/security/oauth2/implicit/README.md (1 hunks)
• distribution/examples/security/oauth2/membrane/README.md (1 hunks)
• distribution/examples/security/oauth2/openid/README.md (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• distribution/examples/security/oauth2/membrane/README.md

🚧 Files skipped from review as they are similar to previous changes (2)

• distribution/examples/security/oauth2/implicit/README.md
• distribution/examples/security/oauth2/github/README.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Analyze (java)

🔇 Additional comments (3)

distribution/examples/security/oauth2/openid/README.md (1)

1-5: LGTM! The new tutorial-style heading is clear and concise. The generated anchor should correctly match the reference in the main README.

distribution/examples/security/oauth2/google/README.md (1)

1-3: LGTM! The heading generates the correct anchor that matches the link in the main README.

distribution/examples/security/oauth2/README.md (1)

3-9: The referenced directories exist and are accessible.

The original review comment incorrectly claims that azure-ad-with-jwts/ and api/ directories don't exist. Both directories are present in the repository with README.md files.

However, there is a legitimate issue: the anchor link for the API example is broken. Line 7 references api#tutorial-oauth2-resource-owner-password-flow, but the actual main heading in api/README.md is "# Protecting an API with OAuth2 Using the Resource Owner Password Flow", which generates the anchor #protecting-an-api-with-oauth2-using-the-resource-owner-password-flow. Either correct the link on line 7 to match the actual heading, or add a custom anchor ID to the heading in the API README.

The azure-ad-with-jwts anchor link on line 3 is valid and correctly points to the heading "# JWT Token Validation against Microsoft's Azure AD".

Likely an incorrect or invalid review comment.