Skip to content

feat(website): add landing page, docs and manual Pages deployment - #13

Merged
prom3theu5 merged 1 commit into
mainfrom
feat/website
Sep 20, 2026
Merged

prom3theu5 merged 1 commit into
mainfrom
feat/website

Conversation

@prom3theu5

@prom3theu5 prom3theu5 commented Sep 20, 2026 •

Copy link
Copy Markdown
Member

Keryx needs a public website and usage documentation for its external release. Add one Astro project in website/, with a publishing-focused landing page and Starlight docs at /docs/ covering installation, agent skills, publishing, server configuration and CLI reference. Both share light, dark and system colour modes.

Add website CI and a separate deploy-docs workflow that publishes to GitHub Pages only through workflow_dispatch. Deployment reads the Pages URL configuration and supports both the repository path and a future custom domain. The website README documents setup and manual publication.

Validation: Astro builds and all four Playwright tests passed at / and /keryx/; generated project-path links, assets, canonical URLs and sitemap were checked; both workflows pass actionlint. A live Pages deployment has not been run and requires repository Pages setup.

Summary by CodeRabbit

  • New Features

    • Added a Keryx landing page and searchable documentation site.
    • Added documentation covering installation, CLI usage, configuration, publishing, sharing, storage, availability, HTML policies, and agent skills.
    • Added responsive layouts, light/dark/system themes, accessibility styling, and mobile navigation.
    • Added automated deployment to GitHub Pages.
  • Documentation

    • Added project setup, development, testing, build, and deployment guidance.
  • Tests

    • Added browser tests covering themes, navigation, mobile layouts, search, and local-storage fallback.
    • Added automated website build and test checks for pull requests and main-branch updates.

@coderabbitai

coderabbitai Bot commented Sep 20, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 3c8c3332-4f6a-479b-b393-f6bff2a18427

📥 Commits

Reviewing files that changed from the base of the PR and between dd8d1ac and 90b8a54.

⛔ Files ignored due to path filters (2)
  • website/pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
  • website/public/favicon.svg is excluded by !**/*.svg
📒 Files selected for processing (32)
  • .github/workflows/deploy-docs.yml
  • .github/workflows/website.yml
  • website/.gitignore
  • website/README.md
  • website/astro.config.mjs
  • website/package.json
  • website/playwright.config.ts
  • website/pnpm-workspace.yaml
  • website/src/components/DocsTitle.astro
  • website/src/components/ThemeProvider.astro
  • website/src/components/ThemeSelect.astro
  • website/src/content.config.ts
  • website/src/content/docs/docs/agents.md
  • website/src/content/docs/docs/availability.md
  • website/src/content/docs/docs/cli.md
  • website/src/content/docs/docs/configuration.md
  • website/src/content/docs/docs/html-policy.md
  • website/src/content/docs/docs/index.md
  • website/src/content/docs/docs/installation.md
  • website/src/content/docs/docs/pdf.md
  • website/src/content/docs/docs/quickstart.md
  • website/src/content/docs/docs/sharing.md
  • website/src/content/docs/docs/skills.md
  • website/src/content/docs/docs/storage.md
  • website/src/content/docs/docs/versions.md
  • website/src/pages/index.astro
  • website/src/styles/docs.css
  • website/src/styles/landing.css
  • website/src/styles/theme.css
  • website/tests/preview.mjs
  • website/tests/website.spec.ts
  • website/tsconfig.json
 ______________________________________________________________
< Security by obscurity? I can see right through the curtains. >
 --------------------------------------------------------------
  \
   \   (\__/)
       (•ㅅ•)
       /   づ
✨ Finishing Touches
📝 Generate docstrings
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

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.

@prom3theu5
prom3theu5 merged commit 00cf4b7 into main Sep 20, 2026
4 of 5 checks passed
@prom3theu5
prom3theu5 deleted the feat/website branch September 20, 2026 23:13
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