Repository navigation
Tighten the README entry point and fix the tour links - #329
Merged
Merged
Conversation
The tour links pointed at site/demo.html, which GitHub renders as HTML source. They now open the published tour, and the header links straight to Quick Start. Quick Start leads with the requirement and the commands; the evaluation and upgrade notes follow. The feature list is shorter and routes detail to the Wiki, the WebSSH 3 highlights are folded into it, and the support line lists every funding option. Adds the selfhost.directory listing badge.
Codex Review Summary: ✅ CompletedThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
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.
Problem and outcome
"Watch the full tour" and the hero image linked to
site/demo.html. On GitHub that opens the HTML source instead of the tour. Both now point to the published page.The README also made readers scroll past the full feature list and every screenshot before reaching the install commands. This change shortens the path:
linux/amd64orlinux/arm64) and the commands. The evaluation, volume,latestand upgrade notes follow in one paragraph; nothing is dropped, and the warning about Internet exposure is unchanged.FUNDING.yml.Scope and links
Related issue/proposal: none, documentation only.
Target milestone (if accepted into a release): none.
Validation
pytest tests/test_documentation_surface.py tests/test_public_product_surface.py tests/test_branding.py tests/test_repository_hygiene.py tests/test_license_consistency.py tests/test_ci_change_scope.py: 190 passed.scripts/check_repository_hygiene.pyandscripts/check_license_consistency.pypass. The full suite was not run locally.test_demo_links_bypass_previously_cached_tournow requires the published tour URL in the README and rejects the repository path.Delivery
Merging implements the change; it does not publish a versioned release.