Skip to content

docs: Align published v1.1.0 documentation and installation guidance #281

Closed

Description

@abruption

Summary

The English source has a few wording issues that should be corrected without changing runtime behavior:

  • README.md › Update: “install.sh for its bundled copy” is ambiguous. The standalone installer manages a compatibility copy of the skill; clarify that relationship.
  • README.md hero: center only the title, badges, language selector, and brief introduction in <div align="center">, closing the wrapper before body content. Keep visible copy and links unchanged, and keep the structure consistent with the existing Korean, Japanese, and Simplified Chinese README wrappers.
  • RELEASING.md is version-pinned to v1.0.4 but still says to make it stable/Latest after publication and to verify that PyPI has no 1.0.4 files. v1.0.4 is already published and PyPI has its wheel and sdist. Keep the 2026-10-07 HTTP 404 as historical preparation evidence, and label the release-specific steps/status accordingly.
  • RELEASING.md › Source and configuration gates: replace “explicit empty Codex home” with wording that identifies an explicitly selected home that lacks a state database.
  • RELEASING.md › Human review: replace “pending time” with an unambiguous timestamp description.
  • RELEASING.md › Verified standalone installation: clarify that the remote target need not have internet access or a preinstalled session-peer, while the selected agent’s native inbox/queue remains necessary for messaging.

Evidence

Acceptance criteria

  • Make minimal English-source edits only; do not change runtime behavior or broaden support/security claims.
  • For the README hero, preserve all existing text and URLs exactly; the wrapper must end before the first body section, matching the other locale READMEs.
  • Update every affected existing Korean, Japanese, and Simplified Chinese translation in the same isolated PR.
  • Preserve historical release evidence, exact commands/flags, identifiers, links, and safety boundaries.
  • Run the relevant Markdown/i18n/documentation checks and record their results.

PR #278 (Korean) and PR #280 (Japanese/Simplified Chinese) have since been merged. Their centered localized README headers are the reference for this English hero alignment; do not rewrite those already-merged changes. The README hero-alignment subtask may be merged only after normal repository protections and current-head checks/reviews pass, under the user's 2026-10-08 authorization. It does not close this issue because the original English wording and affected-translation corrections remain. No tag, release, package publication, or operational change is part of this issue.

Maintenance scope update — 2026-10-12

The user authorized documentation/test maintenance after published v1.1.0. Reuse this existing issue instead of opening overlapping documentation work. Retain the original wording/installation acceptance above; the English README hero subtask is already merged.

Verified publication sources: https://github.com/abruption/session-peer/releases/tag/v1.1.0 and https://pypi.org/pypi/session-peer/1.1.0/json . Exact release/main source: 8ca77cf; GitHub publishedAt 2026-10-09T06:46:41Z, PyPI wheel/sdist uploaded 2026-10-09T08:04:35.784992Z / 08:04:37.631417Z.

This extension authorizes an isolated docs/tests PR and checks only. No runtime behavior change, merge, tag, release, package publication or operational change is included.

Activity

  1. changed the title [-]docs: Clarify the v1.0.4 release record and installation guidance[/-] [+]docs: Align published v1.1.0 documentation and installation guidance[/+] on Oct 11, 2026
  2. abruption commented on Oct 11, 2026

    @abruption
    OwnerAuthor

    The maintenance PR also updates the publication-status introduction of all four docs/releases/v1.1.0.md translations and the associated documentation regression tests. Historical preparation/security/RC4 evidence is retained; the frozen handoff contract document and fixture are not changed. Current supported experimental handoff scope is kept distinct from the remaining acceptance gates. These are documentation/test-only corrections, not a new runtime release or operational rollout.

  3. abruption commented on Oct 12, 2026

    @abruption
    OwnerAuthor

    Codex review follow-up: documentation maps

    The owner authorized addressing the omitted documentation maps identified in PR #299 (#299 (comment)). This is part of the same published-v1.1.0 maintenance scope, so retain this issue and PR rather than creating overlapping work.

    Additional acceptance:

    • Update docs/README.md and its Korean, Japanese and Simplified Chinese editions: describe v1.1.0 as published stable, limited experimental handoff as shipped with remaining acceptance gates, and v1.0.4 as prior maintenance history.
    • Preserve navigation targets, historical security/validation links and experimental support boundaries.
    • Include all four maps in the publication-status regression check and refresh the canonical source manifest hash.
    • Run documentation tests, generator checks and exact-final-head CI. No runtime change, merge or publication is included.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions