Skip to content

Address important live README review findings - #7

Merged
VolkerChristian merged 5 commits into
mainfrom
docs/install-route-buttons
Oct 10, 2026
Merged

VolkerChristian merged 5 commits into
mainfrom
docs/install-route-buttons

Conversation

@VolkerChristian

@VolkerChristian VolkerChristian commented Oct 10, 2026 •

Copy link
Copy Markdown
Member

Scope

Refines the existing Install route-button and compact-page-banner work, and addresses the important findings from Claude's live GitHub README review. Four participating repositories only: snode.c, mqttsuite, AISuite and CodexUI; .github owns the shared frame and generated organization profile. Not merged.

Important review fixes

  • One clear repository return per supporting page: linked quarter-height banner with repository-identifying alt text; duplicate Back blocks and unused Back SVGs removed. Original full-size root artwork unchanged; every supporting Markdown file still receives the owner-requested banner.
  • Security boundaries surfaced (broker auth/ACL limitations, protected MQTTStore credentials, durable pasted-image retention); user guides separated from historical implementation/qualification records without deleting evidence.
  • One complete echo tutorial and a true application inventory; source-verified operator logging, bridge/mapping field semantics, TLS/private-network WSS templates, external app-server and source SDK consumption instructions.
  • Compatibility and candidate-release wording distinguish source targets/version floors from proven binary compatibility or publication. API buttons enter verified legacy class indexes, labelled as snapshots rather than current installation guidance.
  • Compact three-column organization catalog combines real CI/release data; blank releases use a dash, unavailable badges are not invented. Badge separators and pre-menu redundant content reduced. Shared frame matches these responsibilities.

Verification

  • All 72 Markdown documents in the four repositories rendered with GitHub's Markdown API; all local links/anchors/images checked, including the 68 supporting-page banners.
  • Root first-success code fences unchanged; full worked echo code transferred intact; original root banners/chips/screenshots byte-identical.
  • python3 tools/snodec_sync check, python3 -m unittest discover -s tests -v (33 passed), and generated-profile drift check passed in .github.
  • TLS bridge-network JSON validated against the actual bridge schema. Built AISuite WSS local/TLS help confirms listener, host/port, cert and cert-key options; source inspection backs other new commands/semantics. Full remote broker, authenticated Codex, private VPN/WSS and desktop qualification were NOT run; operator placeholders must be supplied and tested.
  • No workflow, package pipeline, secret, release tag, licence, manifest or AGENTS.md changes. No CI hand dispatch. Failing workflow statuses are not hidden or fixed by this docs change.

Accounting for this review-fix follow-up

Production-source physical lines: +8/-10 (existing profile renderer +4/-4; obsolete CMake comment corrected +4/-6, executable CMake byte-for-byte equivalent after removing comments/blank lines). No runtime/build behavior change and no production-code growth. Test source: +37/-7, preserving original checks and adding compact-status regression coverage. Documentation/static assets: +1266/-1614; historical record extraction reuses the existing banner assets.

Claude's main report and visual supplement informed this change; its full completion supplement hit its session quota. This is not a claim of fresh Claude approval. Optional root-banner/naming redesign and CI/runtime repairs are outside this scoped follow-up.

This repository

Rendered preview. Follow its menu links through the documentation system.

Review-fix accounting here: {"production": {"added": 4, "deleted": 4}, "tests": {"added": 37, "deleted": 7}, "documentation_and_assets": {"added": 58, "deleted": 57}}

Final mobile check

Long repository/kind labels receive GitHub-supported zero-width break opportunities in display text only; catalog identity and canonical URLs are unchanged. This fixes the remaining phone-width overflow without repository-specific exceptions. The actual published organization preview was visually checked at 390 px. The renderer retains one identity authority, and no workflow behavior changes.

@VolkerChristian VolkerChristian changed the title Align README frame with installation route buttons Define compact page identity and installation route styling Oct 10, 2026
@VolkerChristian VolkerChristian changed the title Define compact page identity and installation route styling Address important live README review findings Oct 10, 2026
@VolkerChristian
VolkerChristian merged commit 7921376 into main Oct 10, 2026
2 checks passed
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