Skip to content

Publish preview, privacy, storage, deletion, and support documentation #9

Closed

Description

@lastobelus

Outcome

A prospective preview user can understand the product promise, compatibility, data boundary, cleanup path, and support channel in under two minutes.

Acceptance criteria

  • README, site, and next release consistently say early preview.
  • macOS, architecture, and Node requirements are explicit.
  • The review format compatibility policy is explicit.
  • Documentation states what is downloaded, what stays local, whether telemetry exists, and how the loopback API is protected.
  • Storage locations, retention behavior, and safe deletion/reinstall instructions are documented.
  • Limitations and supported-Markdown boundaries are linked from the main setup path.
  • One support path and a bug-report template request useful sanitized diagnostics.

Activity

  1. added this to the Focused preview milestone on Aug 3, 2026
  2. self-assigned this
    on Aug 3, 2026
  3. added
    documentationImprovements or additions to documentation
    launch:blockerBlocks the next Markover announcement gate
    launchWork required for an announcement or release gate
    on Aug 3, 2026
  4. lastobelus commented on Aug 3, 2026

    @lastobelus
    OwnerAuthor

    Node support decision from the CI-readiness interview:

    • Markover will retire Node 20, which reached end of life in April 2026.
    • The precise minimum will be Node 22.13.0, matching the current development dependency floor.
    • CI will verify the exact minimum (22.13.0) and the Node 24 release line.
    • Issue Add pull-request and main-branch continuous integration #8 owns the mechanical manifest and existing documentation updates.
    • This issue should verify that all preview-facing compatibility copy consistently says Node 22.13.0 or newer and does not retain a Node 20 claim.
  5. moved this from Todo to In Progress in Markover Announcement Readinesson Aug 7, 2026
  6. lastobelus commented on Aug 7, 2026

    @lastobelus
    OwnerAuthor

    Work intent

    phase: complete
    summary: "PR #94 merged the completed audience-separated documentation, dedicated public agent workflow, tested durability evidence, and release-runbook move"
    touch-points:
      - docs/user is the GitHub Pages source root for the website, human guide, dedicated agent workflow, privacy/storage/recovery, limitations, assets, styles, and user support
      - docs/developer is the repository root for contributor setup, local-service security, architecture, evidence, release maintenance, and contributor detail
      - Pages deploys build/docs/user only, preserving public URL shapes while excluding developer documentation
      - the human guide owns reviewer choices and actions; docs/user/agents owns exact CLI, review ID, deep-link handoff, waiting, retrieval, reopening, and interpretation policy
      - user pages state consequences, actions, recovery, and exclusions; developer pages retain exact authorization, autosave, shutdown, and verification mechanics
      - complete uninstall guidance covers launcher-cached versions and every manually installed Markover.app copy
      - docs/developer/releasing.md contains the merged PR #83 release truth with no legacy compatibility copy
      - final durability claims consume the tested and merged evidence from issue #39 and PR #82 without widening its exclusions
      - README and user surfaces use Early macOS preview, Apple Silicon-only current availability, and the canonical user checklist for #10
      - GitHub Discussions is general user support with specialized bug and private-security intake
      - merged PR #76 review URL behavior is integrated into the dedicated agent page and human fallback instructions
      - merged issue #63 PR #104 About-panel work is present beneath the landed documentation
      - draft PR #51 must consume the canonical docs paths and wording when it rebases
    blocked-by: []
    may-block:
      - "#10 focused-preview prerelease"
      - "#16 launch-assets PR #51 rebase"
      - "#17 focused-preview announcement"
      - "#84 late Broad announcement human edit"
    branch: "t3code/issue-nine-planning"
    pull-request: "https://github.com/lastobelus/markover/pull/94"
    head: "c34e3e4"
    merge-commit: "7c4eb74be031eaf9d0f441d89128c782f3ddd160"
    validation:
      - "npm run check"
      - "npm test (424 tests on rebased parent)"
      - "focused docs test (9 tests on final head)"
      - "all four current-head CI jobs passed, including both packaged smoke jobs"
      - "Codex terminal review found no major issues on c34e3e4"
      - "zero unresolved review threads and clean mergeability before merge"
      - "desktop T3 browser pass for all five deployed pages: no horizontal overflow; no failed eager images; audience links resolve"
      - "narrow T3 resize controller timed out at 15 and 60 seconds; automated local-link containment and responsive CSS tests passed"
    thread: "start-issue-9-20260806-a4de2d3b7c91f204"
  7. lastobelus commented on Aug 7, 2026

    @lastobelus
    OwnerAuthor

    Release dependency update

    PR #68 is merged, so the ordering constraint on moving docs/releasing.md is resolved. The Apple Silicon-only release work now updates the runbook and compatibility language on agent/silicon-only-v0.1.3; consume those canonical paths when this issue resumes.

    This does not clear issue #9 overall: issue #39 remains the live blocker for final durability and recovery claims. Native Intel compatibility text belongs to Broad announcement issue #80, not the focused Apple Silicon documentation gate.

  8. lastobelus commented on Aug 7, 2026

    @lastobelus
    OwnerAuthor

    Release-documentation dependency update

    The Apple Silicon release surface now exists at v0.1.3, with explicit Apple Silicon compatibility, hardened ad-hoc / not Apple-verified / not notarized language, checksums, attestations, and rollback guidance.

    That unblocks validating the compatibility and download portions of this issue against real public URLs. The issue is not fully unblocked: #39 still blocks the final durability/storage claims. #12 is closed and its authorization boundary is already reflected in the current release documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationlaunchWork required for an announcement or release gatelaunch:blockerBlocks the next Markover announcement gate

Projects

Relationships

None yet

Development

No branches or pull requests

Issue actions