Skip to content

docs: make website README clearer for public visitors - #10

Merged
eirabie merged 1 commit into
mainfrom
codex/public-readme
Oct 5, 2026
Merged

eirabie merged 1 commit into
mainfrom
codex/public-readme

Conversation

@eirabie

@eirabie eirabie commented Oct 5, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Public visitors need a clear introduction and setup links before development details. The README now leads with OpenAthan's purpose, installation and recovery links, supported hardware, and the fresh-install data-erasure notice. It keeps existing-owner update guidance prominent, describes release checks as scheduled twice hourly, and moves simulator, development-server, and redirect details into contributor guidance.

Area

  • Homepage or public documentation
  • Hardware/build guidance
  • Browser installer
  • Project or deployment configuration

Validation

  • Relevant routes and links were checked
  • User-facing behavior was tested in applicable browsers and viewport sizes — not applicable to documentation-only changes
  • Accessibility impact was reviewed
  • No firmware is compiled by this repository

Formatting, whitespace, and link checks passed, and the rendered README was visually reviewed in Chromium. Website CI passed on commit e67e538. Physical installer validation is not required for this documentation-only change.

Licensing and privacy

  • No new third-party media or dependency licensing concerns
  • No new collection or transmission of user data
  • Any licensing, attribution, or privacy impact is documented — existing licensing and location-service disclosure are retained

@eirabie
eirabie marked this pull request as ready for review October 5, 2026 02:34
@eirabie
eirabie merged commit b53c267 into main Oct 5, 2026
2 checks passed
@eirabie
eirabie deleted the codex/public-readme branch October 5, 2026 02:37
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