Repository navigation
docs: make website README clearer for public visitors - #10
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
Validation
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