Skip to content

Tighten the README entry point and fix the tour links - #329

Merged
bifrost0x merged 1 commit into
mainfrom
docs/readme-listing-details
Nov 11, 2026
Merged

bifrost0x merged 1 commit into
mainfrom
docs/readme-listing-details

Conversation

@bifrost0x

Copy link
Copy Markdown
Owner

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:

  • The header links directly to Quick Start.
  • Quick Start starts with the requirement (Docker with Compose, linux/amd64 or linux/arm64) and the commands. The evaluation, volume, latest and upgrade notes follow in one paragraph; nothing is dropped, and the warning about Internet exposure is unchanged.
  • The feature list drops implementation detail and points to the Wiki for depth. The diagnostics bullets and the SMB paragraph stay verbatim.
  • "New in WebSSH 3" is folded into the feature list; the 2.x upgrade pointer moves to the top of Features.
  • The duplicate upgrade-notes link is removed, and the support line lists GitHub Sponsors and Patreon next to Buy Me a Coffee, matching FUNDING.yml.
  • Adds the selfhost.directory listing badge (plain link, no tracking parameters).

Scope and links

Related issue/proposal: none, documentation only.
Target milestone (if accepted into a release): none.

Validation

  • Exact tested revision and checks/results: 9e597fb. 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.py and scripts/check_license_consistency.py pass. The full suite was not run locally.
  • Regression/acceptance coverage: test_demo_links_bypass_previously_cached_tour now requires the published tour URL in the README and rejects the repository path.
  • Compatibility, upgrade and security impact: none. No runtime, configuration or deployment file changes. Security guidance in the README is reordered, not removed; the backup credential note remains under Security Boundary.
  • Remaining deployment-specific checks or explicit limitations: the rendered README should be checked once on GitHub (header anchor, badge row).

Delivery

Merging implements the change; it does not publish a versioned release.

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.
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 11, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-11T08:51:09.367247Z 9e597fb PR opened
🔒 Security Review ✅ Completed 2026-11-11T08:55:07.657697Z 9e597fb PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@bifrost0x
bifrost0x merged commit 581cc3c into main Nov 11, 2026
34 checks passed
@bifrost0x
bifrost0x deleted the docs/readme-listing-details branch November 11, 2026 09:01
@github-project-automation github-project-automation Bot moved this from Backlog to Done in WebSSH Roadmap Nov 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant