Skip to content

[Website] Build the SightAdapt GitHub Pages site #99

Open

Description

@KeyffMS

Parent project: #95
Depends on: #96, #98, #124

Objective

Maintain a fast, accessible static SightAdapt product site with:

  1. the canonical production deployment at https://aiteracja.pl/sightadapt/; and
  2. a functional GitHub Pages fallback at https://keyffms.github.io/SightAdapt/.

The production site and GitHub Pages fallback must present consistent product identity, release links and policy content.

Hosting model

  • Canonical production URL: https://aiteracja.pl/sightadapt/
  • Production website repository: https://github.com/KeyffMS/SightAdapt-website
  • Production deployment: the Aiteracja server synchronizes the website repository and serves it below /sightadapt/.
  • GitHub Pages fallback: https://keyffms.github.io/SightAdapt/
  • GitHub Pages source/build remains in the main SightAdapt repository under site/ with the maintained .github/workflows/pages.yml workflow.
  • GitHub Pages is a fallback, not the canonical indexed product URL.

Required pages

  • Home/product overview.
  • Features.
  • Download and release history.
  • Documentation/getting started.
  • Privacy.
  • License and third-party notices.
  • Security and vulnerability reporting.
  • Contact/support.

Acceptance criteria

  • Select and document a static-site architecture with minimal dependencies.
  • Implement responsive layouts for desktop and mobile.
  • Meet WCAG-oriented keyboard, contrast, focus and semantic-markup expectations appropriate to an accessibility project.
  • Use SightAdapt™ and the approved canonical description consistently.
  • Add screenshots or diagrams with meaningful alternative text.
  • Link all downloads to canonical GitHub Releases.
  • Add visible repository, issue tracker, privacy, license and security links.
  • Avoid cookies, analytics and remote tracking by default.
  • Add a reproducible local build/preview command.
  • Add automated link, HTML and accessibility checks where practical.
  • Deploy automatically from the protected default branch after CI passes.
  • Preserve a functional fallback at the github.io address.

Canonical URL clarification

The implementation must follow #124:

  • canonical product root: https://aiteracja.pl/sightadapt/;
  • GitHub Pages origin/fallback: https://keyffms.github.io/SightAdapt/;
  • https://sightadapt.aiteracja.pl/ is only an optional permanent redirect and must not be treated as canonical.

Repository metadata work from #97 was closed separately and is not a blocker for implementing the site itself.

Implementation status — 2026-09-24

PR #156 was merged as aa639776bc072178b77026aaca9c76100116b3c6.

Implemented and validated:

  • dependency-free static site in site/;
  • Home, Features, Download, Documentation, How it works, FAQ, Releases, Privacy, Legal, Security and Support pages from [Website/Content] Define the complete SightAdapt™ website content and page copy #124;
  • canonical Aiteracja URL remains https://aiteracja.pl/sightadapt/;
  • the same source builds for GitHub Pages /SightAdapt/ and canonical /sightadapt/;
  • canonical repository SVG brand assets are copied into the generated site at build time;
  • current immutable 0.5.0.50-alpha release, direct official download, SHA-256, SBOM and compliance links are present;
  • no cookies, analytics, remote fonts, advertising, session replay or unsolicited third-party embeds;
  • semantic HTML, skip navigation, visible focus, meaningful alt text, reduced-motion handling and keyboard-accessible mobile-menu disclosure;
  • tools/build-site.py provides reproducible builds;
  • tools/verify-site.py checks required pages, internal links, title/H1/meta/canonical structure, alt text, heading progression and forbidden tracking/embed markers;
  • workflow run 35989612623 validated both build paths successfully before merge;
  • post-merge full repository build/test run 35989985569 completed successfully.

Remaining repository-admin blockers

The post-merge workflow built and uploaded the Pages artifact successfully, but the deploy job failed while GitHub reports has_pages: false. GitHub Pages must be enabled for this repository with GitHub Actions as the source, then the workflow can be rerun.

The default branch is also still unprotected (protected: false, no repository rulesets), so the acceptance criterion requiring deployment from a protected default branch remains blocked by #87.

Do not close #99 until:

  1. [P1] [Contributions/IP] Apply the protected-main ruleset for enforced DCO #87 protects main with required DCO/build checks and no standing bypass;
  2. GitHub Pages is enabled with GitHub Actions as its source;
  3. the Pages workflow completes successfully;
  4. https://keyffms.github.io/SightAdapt/ is opened and verified as the functional fallback.

Production/fallback split — 2026-09-24

The production and fallback roles are now intentionally separate:

Canonical production

Repository:

https://github.com/KeyffMS/SightAdapt-website

Current synchronized production-source commit:

2deab0776db395d9002aee0aa6bec2425748d900

That repository contains the canonical /sightadapt/ website content and is pulled to the Aiteracja server. The latest synchronized content includes the published immutable v0.5.0.50-alpha download, checksum, release history, approved privacy content, legal notices, security guidance and support routes.

GitHub Pages fallback

The main SightAdapt repository still contains the separate static fallback implementation in site/ and the GitHub Pages deployment workflow. This work is not superseded.

GitHub Pages remains intentionally open as the fallback deliverable because GitHub currently reports Pages disabled for the repository and main remains unprotected.

Therefore the two unchecked acceptance criteria remain valid:

  • deploy the fallback automatically from protected main after CI;
  • verify the live https://keyffms.github.io/SightAdapt/ fallback.

Production publication at Aiteracja does not remove or replace the GitHub Pages fallback requirement.

Activity

  1. self-assigned this
    on Jul 27, 2026
  2. 39 remaining items

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions