Skip to content

docs(guides): split the per-product login walkthroughs into their own guides - #51

Merged
kanushka merged 3 commits into
wso2:mainfrom
kanushka:grill-with-docs-issue-45-b3f9dc
Aug 10, 2026
Merged

docs(guides): split the per-product login walkthroughs into their own guides#51
kanushka merged 3 commits into
wso2:mainfrom
kanushka:grill-with-docs-issue-45-b3f9dc

Conversation

@kanushka

Copy link
Copy Markdown
Contributor

Closes #45.

  • Moves the Asgardeo (§2) and Identity Server (§3) walkthroughs out of docs/guides/login.md into login-asgardeo.md and login-identity-server.md, beside the existing login-thunder.md.
  • login.md is now the product-generic path only: what the shell needs, writing the context document, logging in, CI, troubleshooting, proving it. 1090 → 783 lines. §4–§9 renumbered to §2–§7.
  • Each product guide is self-contained and opens with a "What is different about " section carrying that product's aud behaviour and its measurement date — the one value that is not portable between products.
  • Machine-to-machine registration for CI moved into each product guide; login.md §5 keeps the context document and job wiring.
  • Troubleshooting stays one shared error-code table in login.md; only single-product failures live in a product guide.
  • Cross-references updated in docs/README.md, test/smoke/RUNNING.md, test/smoke/env.example, config.go, login_smoke_test.go, and both research docs. Every relative link and in-guide anchor was checked to resolve.
  • make test, make lint (both tag sets), and make smoke-build all pass.

@kanushka
kanushka requested a review from hevayo as a code owner August 10, 2026 07:31
@coderabbitai

coderabbitai Bot commented Aug 10, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@kanushka, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 15 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 9a475894-f765-45f8-9efc-e3e7cea89155

📥 Commits

Reviewing files that changed from the base of the PR and between 7401b14 and fab16f7.

📒 Files selected for processing (2)
  • docs/guides/login-thunder.md
  • docs/guides/login.md
📝 Walkthrough

Summary

  • Split Asgardeo and Identity Server 7.x registration walkthroughs into separate guides.
  • Kept login.md focused on the shared login, CI, troubleshooting, and verification workflow.
  • Updated the ThunderID guide to use the shared workflow.
  • Updated documentation, smoke-test references, configuration links, and section anchors.
  • Added product-specific audience, CI, context, and validation guidance.
  • Verified relative links, anchors, tests, lint checks, and smoke-build commands.

Walkthrough

The login documentation now separates product-specific registration from the shared login workflow. New Asgardeo and Identity Server 7.x guides document registration, tokens, audiences, trust, CI credentials, and browserless login. The ThunderID guide now points to the shared workflow. The main guide has renumbered sections and product-specific guidance. Research, README, smoke-run, configuration, environment, and test references were updated.

Suggested reviewers: hevayo

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes splitting per-product login walkthroughs into separate guides.
Description check ✅ Passed The description accurately explains the guide split, section renumbering, cross-reference updates, and validation performed.
Linked Issues check ✅ Passed The changes implement issue #45 by separating the product guides, preserving a generic login guide, and updating related references.
Out of Scope Changes check ✅ Passed The changes are limited to the requested documentation restructuring and the required cross-reference updates.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/guides/login.md (1)

57-61: 🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick win

Use product-neutral terminology for the protected resource.

The shared requirement says every deployment needs an API resource. Thunder configures a resource server and sends its URI as the resource indicator. Replace API resource with a product-neutral term such as protected resource, and keep product-specific object names in each walkthrough.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/guides/login.md` around lines 57 - 61, Replace the product-specific “API
resource” wording in the JWT access-token description with “protected resource,”
while preserving the existing explanation and product-specific object names in
the walkthroughs.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/guides/login-identity-server.md`:
- Around line 113-127: Reorder the certificate setup in the guide so the primary
procedure creates or installs a deployment-specific keypair or CA whose private
key is uniquely held by the operator. Move the existing default WSO2 certificate
trust commands into an explicitly temporary local fallback section, retaining
the warnings, TLS scoping, login-keychain limitation, and cleanup command.

In `@docs/guides/login.md`:
- Line 380: Update the CI configuration guidance around the product-specific
identity block and the Thunder audience section to use product-correct values
for type, issuer, endpoint, tenant, provider, and absolute resource-server URI;
direct readers to the corresponding identity block in section 2.2 or provide
separate CI examples for each product, and describe Thunder’s value as the
resource-server URI rather than a resource identifier.

---

Outside diff comments:
In `@docs/guides/login.md`:
- Around line 57-61: Replace the product-specific “API resource” wording in the
JWT access-token description with “protected resource,” while preserving the
existing explanation and product-specific object names in the walkthroughs.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 66cc55c5-7b38-48d8-8b25-579b09522b51

📥 Commits

Reviewing files that changed from the base of the PR and between b12a7c3 and 7401b14.

📒 Files selected for processing (11)
  • docs/README.md
  • docs/guides/login-asgardeo.md
  • docs/guides/login-identity-server.md
  • docs/guides/login-thunder.md
  • docs/guides/login.md
  • docs/research/asgardeo-redirect-uri-and-scope-narrowing.md
  • docs/research/product-authentication-compatibility.md
  • test/smoke/RUNNING.md
  • test/smoke/config.go
  • test/smoke/env.example
  • test/smoke/login_smoke_test.go

Comment thread docs/guides/login-identity-server.md
Comment thread docs/guides/login.md
@kanushka
kanushka merged commit 686e3d7 into wso2:main Aug 10, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Split the per-product login walkthroughs into their own guides

2 participants