Skip to content

feat: Update activation code redemption flow#494

Merged
elibosley merged 2 commits into
mainfrom
codex/update-redeem-activation-code-flow
May 28, 2026
Merged

feat: Update activation code redemption flow#494
elibosley merged 2 commits into
mainfrom
codex/update-redeem-activation-code-flow

Conversation

@elibosley
Copy link
Copy Markdown
Member

@elibosley elibosley commented May 28, 2026 •
edited by coderabbitai Bot
Loading

Summary

  • Update the Redeem Activation Code docs to describe the current flow from the two supported entry points: Tools > Registration and the top-right Manage License menu.
  • Add screenshots for the registration page, missing-key states, account app landing page, redemption form, and required final license install button.
  • Clarify that users must finalize the license install after redeeming an activation code.

Why

The previous page referenced older menu labels and implied that redeeming the code alone completed the license installation. The current UI sends users through one of two server entry points into the account app, then requires a final install confirmation.

Validation

  • pnpm exec remark docs/unraid-account/redeem-activation-code.mdx --quiet --frail
  • Verified all referenced /img/unraid-account/... assets exist.
  • Full docs build not run per repository guidance.

Summary by CodeRabbit

  • Documentation
    • Updated activation code redemption guide with detailed step-by-step instructions for Unraid 6.10+ users
    • Added explicit guidance for WebGUI navigation and account app finalization steps
    • Clarified upgrade activation code redemption process
    • Enhanced troubleshooting section with improved guidance for common issues

Review Change Stack

@elibosley
docs(account): update activation code redemption flow
843e096 
- Purpose: document the current activation code redemption experience with updated screenshots.

- Before: the page referenced older menu labels and implied redemption alone completed license installation.

- Problem: users now enter through Tools > Registration or the top-right Manage License menu and must finalize the license install after redemption.

- Change: describe both entry points, missing-key variants, account app redemption, and the required final install button.

- Implementation: add new account UI screenshots and reference them from the existing Redeem Activation Code page while preserving heading names.
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 28, 2026 •
edited
Loading

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 471feef7-a480-45b9-89d4-ef650a74a53c

📥 Commits

Reviewing files that changed from the base of the PR and between c46d205 and c25252e.

⛔ Files ignored due to path filters (7)
  • static/img/unraid-account/account-ui-landing-page-no-code.png is excluded by !**/*.png
  • static/img/unraid-account/finalize-install-button.png is excluded by !**/*.png
  • static/img/unraid-account/missing-key-tools-registration-ui.png is excluded by !**/*.png
  • static/img/unraid-account/missing-key-upc-ui.png is excluded by !**/*.png
  • static/img/unraid-account/redeem-code-account-ui.png is excluded by !**/*.png
  • static/img/unraid-account/tools-registration-ui.png is excluded by !**/*.png
  • static/img/unraid-account/upc-ui.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • docs/unraid-account/redeem-activation-code.mdx

Disabled knowledge base sources:

  • Linear integration is disabled

You can enable these sources in your CodeRabbit configuration.

📝 Walkthrough

Walkthrough

This PR updates the Unraid account activation code redemption documentation with a restructured step-by-step guide for Unraid 6.10+. The instructions now detail specific WebGUI navigation paths, handle "Missing key file" prompts, include account-app finalization steps, and consolidate upgrade-code guidance. Troubleshooting advice is clarified to guide users to reopen the account app when server detection is incorrect.

Changes

Activation Code Redemption Documentation

Layer / File(s) Summary
Redemption instructions and troubleshooting guide
docs/unraid-account/redeem-activation-code.mdx		 Main redemption instructions are restructured into a detailed step-by-step flow for Unraid 6.10+ with explicit WebGUI/menu entry points, "Missing key file" handling, account-app redemption with finalization, and a streamlined upgrade-code subsection. "Important Notes" bullets are updated to align with the new flow. Troubleshooting guidance in "Need Help" is adjusted to clarify reopening the account app when the correct server is not displayed.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

A rabbit hops through docs with glee, 🐰
Step by step, for all to see,
Activation keys now plainly stated,
Clear instructions, consolidated!
Users guided through WebGUI's door,
Redemption flows so clear and more. ✨

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/update-redeem-activation-code-flow

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint skipped: no ESLint configuration detected in root package.json. To enable, add eslint to devDependencies.

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

@elibosley elibosley changed the title [codex] Update activation code redemption flow feat: Update activation code redemption flow May 28, 2026
@elibosley
docs(account): remove alternate redemption path
c25252e 
- Purpose: keep the redemption instructions focused on the two supported server entry points.

- Before: the page included an Alternative Account Dashboard section that repeated the same account app steps.

- Problem: that wording made the account dashboard sound like a separate redemption option rather than the destination after opening the flow from the server.

- Change: remove the duplicate alternative section so Tools > Registration and top-right Manage License remain the only documented entry points.

- Implementation: leave the shared account app redemption and final install steps in the main Unraid 6.10+ flow.
@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented May 28, 2026 •
edited
Loading

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs		 unraid-docs c25252e Commit Preview URL

Branch Preview URL		 May 28 2026, 03:13 PM

@elibosley elibosley marked this pull request as ready for review May 28, 2026 15:16
@elibosley elibosley merged commit eb2cf77 into main May 28, 2026
4 checks passed
@elibosley elibosley deleted the codex/update-redeem-activation-code-flow branch May 28, 2026 15:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@elibosley