Skip to content

docs: refresh the root README for beta.64 and name the 0.4.0 breaking section - #32

Merged
tada5hi merged 1 commit into
masterfrom
docs/beta64-readme
Sep 5, 2026
Merged

docs: refresh the root README for beta.64 and name the 0.4.0 breaking section#32
tada5hi merged 1 commit into
masterfrom
docs/beta64-readme

Conversation

@tada5hi

Copy link
Copy Markdown
Contributor

Follow-up to #29 before the 0.4.0 release PR (#31) merges.

  • The root README quickstart used the pre-0.2.0 ui: section, which the strict schema now rejects (additional properties 'ui' not allowed), and a second admin hostname that no longer exists. Rewritten for the combined server with one hostname; the block was rendered against the chart to confirm it is valid.
  • Highlights, the default-install sentence and the charts table described the retired client-admin-console process and the two-origin URL model. Updated to the beta.64 roles (combined server, optional split consoles, optional worker).
  • BREAKING.md heading Next release (unreleased) becomes 0.4.0, the version release-please computed in chore: release master #31, because release-please never edits that file (0.2.0 shipped with "(unreleased)" in its heading).

Docs only; no chart changes.

… section
The quickstart still used the pre-0.2.0 ui section, which the strict schema
rejects, and a second admin hostname that no longer exists. The highlights and
chart table described the retired client-admin-console process. release-please
does not edit BREAKING.md, so the heading names the version it will ship under.
CopilotAI lite review requested due to automatic review settings September 5, 2026 13:25
@coderabbitai

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 9 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

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

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Team

Run ID: 50065de2-73eb-436a-877b-0ddb1fee6111

📥 Commits

Reviewing files that changed from the base of the PR and between 226f784 and de75ebc.

📒 Files selected for processing (2)
  • README.md
  • charts/authup/BREAKING.md

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.

CopilotAI 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.

🟢 Approval recommended

Documentation updates align with existing chart values/keys (e.g., server.splitConsoles, worker.enabled) and don’t introduce code or chart behavior changes.

Pull request overview

Updates repository documentation to match the Authup beta.64 chart topology introduced in #29 and to align charts/authup/BREAKING.md with the upcoming 0.4.0 release naming (per release-please in #31).

Changes:

  • Refresh root README highlights and install/quickstart text to reflect the combined-server default, one-hostname model, and optional split consoles/worker.
  • Remove the deprecated ui: quickstart values that the strict schema rejects.
  • Rename the charts/authup/BREAKING.md “Next release (unreleased)” heading to 0.4.0.
File summaries
FileDescription
README.mdUpdates quickstart/highlights to beta.64 roles/topology and removes obsolete ui: config.
charts/authup/BREAKING.mdRenames the unreleased breaking-changes heading to 0.4.0 for the release.
Review details
  • Files reviewed: 2/2 changed files
  • Comments generated: 0
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@tada5hi
tada5hi merged commit 0ace5cf into masterSep 5, 2026
5 checks passed
Sign up for freeto 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.

2 participants

@tada5hi