Skip to content

Deploy the latest RL-Align website with GitHub Pages - #2

Merged
Flink-ddd merged 1 commit into
mainfrom
deploy/github-pages-migration
Sep 16, 2026
Merged

Flink-ddd merged 1 commit into
mainfrom
deploy/github-pages-migration

Conversation

@Flink-ddd

@Flink-ddd Flink-ddd commented Sep 16, 2026

Copy link
Copy Markdown
Contributor

The public website is moving from Sites hosting to GitHub Pages so the community can manage releases from this repository. This migration also includes the three pending website requests already visible in the existing site: the compact copyright footer, email contact and floating disclosure, and the typography refinements.

This change:

  • Preserves the latest homepage, artwork, locally hosted font and community interactions.
  • Adds BASE_PATH support for both the GitHub project URL and the rlalign.ai domain, including the 404 home links and font URL.
  • Validates root and project-path builds on pull requests. A main-branch push or manual run builds and publishes the configured Pages site.
  • Uses actions/deploy-pages@v4 and documents the migration and future preview → batched PR → merge → publish workflow.

Validation: local checks passed for the current root output's 16 referenced resources. GitHub Actions will perform the actual Rust builds and resource checks for both deployment paths; Rust is not installed in the current editing environment.

One-time setup: enable Settings → Pages → Source: GitHub Actions. After the Pages URL is verified, configure rlalign.ai as the custom domain, update DNS, rerun the workflow for the root-domain build, and enable HTTPS when the certificate is ready. No DNS changes have been made by this PR. The RL-Kernel documentation site is unchanged.

Summary by CodeRabbit

  • New Features

    • Added GitHub Pages deployment support with automatic validation for pull requests and deployment after approved changes reach the main branch.
    • Added support for both custom-domain and project-subpath hosting.
    • Added an expandable email contact option with improved keyboard and focus behavior.
    • Updated the footer with navigation, copyright, and organization links.
    • Added contact information and refreshed page labels and social links.
  • Bug Fixes

    • Improved asset and link handling for hosted subpaths, including the 404 page.
  • Documentation

    • Updated hosting and maintenance guidance for GitHub Pages migration.

@coderabbitai

coderabbitai Bot commented Sep 16, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: b98566aa-fdf0-4071-9b29-b7e15e82bade

📥 Commits

Reviewing files that changed from the base of the PR and between beb1cc0 and 0a40005.

⛔ Files ignored due to path filters (3)
  • dist/assets/site.css is excluded by !**/dist/**
  • dist/assets/site.js is excluded by !**/dist/**
  • dist/index.html is excluded by !**/dist/**
📒 Files selected for processing (9)
  • .github/workflows/pages.yml
  • MAINTENANCE.zh-CN.md
  • README.md
  • assets/site.css
  • assets/site.js
  • scripts/check-static.py
  • src/main.rs
  • templates/404.html
  • templates/index.html

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The site now supports root and project-subpath builds for GitHub Pages. The workflow validates pull requests and deploys eligible pushes to main. The site also adds an email disclosure, updated contact and footer content, and revised responsive styling.

Changes

Pages site update

Layer / File(s) Summary
Base-path build and validation
src/main.rs, templates/*, scripts/check-static.py, .github/workflows/pages.yml
BASE_PATH is validated and applied to generated paths. The checker validates HTML, CSS, assets, templates, and contact content for root and project-subpath builds.
Pages workflow and deployment documentation
.github/workflows/pages.yml, MAINTENANCE.zh-CN.md, README.md
The workflow checks pull requests and pushes, then deploys validated builds from eligible main pushes. Documentation describes Pages configuration, domain setup, local checks, and the separate Sites preview.
Contact, footer, and presentation updates
templates/index.html, assets/site.css, assets/site.js, MAINTENANCE.zh-CN.md
The site adds an email disclosure and contact link, updates labels and typography, and changes the footer layout for desktop and mobile views. JavaScript closes the disclosure on outside clicks or Escape.

Priority: ➖ Normal

Estimated code review effort: 3 (Moderate) | ~25 minutes

Change: Feature

Merge Risk: ⚪ Minimal · up to 0a400

The site migration’s base-path handling, static-resource validation, and scoped deployment permissions have no identified merge-blocking issue.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 5 functions across 3 files. (6 skipped: 6 … Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the main change: migrating and deploying the RL-Align website with GitHub Pages. It is concise and relevant to the workflow, hosting, and documentation changes.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 5 functions across 3 files. (6 skipped: 6 unsupported.)

  • Fix all pre-merge checks with AI
✨ Finishing Touches 💡 1
📝 Generate docstrings 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch deploy/github-pages-migration

Warning

Git: CodeRabbit could not clone the repository, so clone-backed analysis was skipped and this review may be incomplete. Verify repository clone access, such as SSH credentials, before requesting another full review. If clone access is intentionally unavailable, use path_filters to narrow the review scope.


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

@Flink-ddd
Flink-ddd merged commit f192703 into main Sep 16, 2026
4 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.

1 participant