Skip to content

README release surface cleanup #551

Description

@flyingrobots

Migrated from a local Wesley Method backlog card after adopting METHOD v2.1.0 tracker doctrine.

  • Source path: docs/method/backlog/bad-code/DX_readme-release-surface-cleanup.md
  • Original filesystem lane: bad-code
  • Canonical Method lane label: lane:bad-code
  • Legend: DX
  • Migration issue: Migrate Wesley Method backlog to GitHub Issues #548
  • Migrated on: 2026-06-04

Original Local Backlog Card

README release surface cleanup

  • Lane: bad-code
  • Legend: DX

Why now

The May 5 documentation audit found small but public-facing README release
surface issues: the license badge URL omits the flyingrobots/wesley owner,
the module quick start lacks a verification/troubleshooting link, and the
@wesley/runtime-node package row says 0% -> Alpha while the release branch
depends on it for shared module entry loading and trust controls.

Hill

A reader can trust the README badges, package matrix, and quick-start module
flow without cross-checking source or package internals.

Done looks like

  • the license badge points at flyingrobots/wesley
  • the module quick start links to module authoring/loading troubleshooting
  • the @wesley/runtime-node package matrix row reflects its current release
    responsibility, or explains why its progress remains low
  • README, GUIDE, ARCHITECTURE, CONTRIBUTING, and SECURITY use one consistent
    module-first release posture

Repo Evidence

  • README.md
  • docs/GUIDE.md
  • docs/ARCHITECTURE.md
  • docs/audit/2026-05-05_documentation-quality.md

Activity

  1. added
    triage:bad-codeDebt intake that still needs scheduling, closure, or a repo move
    legend:DXDeveloper experience work
    on Jun 4, 2026
  2. coderabbitai commented on Jun 4, 2026

    @coderabbitai
    🔗 Related PRs

    #475 - Merge-worthy unmerged branches into omnibus reconciliation branch [merged]
    #476 - Release/v0.1.0 [merged]
    #497 - chore(release): v0.0.1 [merged]
    #503 - Revise README.md for clarity and additional information [merged]
    #506 - chore(release): v0.0.3 [merged]


    📝 Issue Planner

    Check the box below or use the @coderabbitai plan command to generate an implementation plan and prompts that you can use with your favorite coding assistant.

    • Create Plan

    🧪 Issue enrichment is currently in open beta.

    You can configure auto-planning by selecting labels in the issue_enrichment configuration.

    To disable automatic issue enrichment, add the following to your .coderabbit.yaml:

    issue_enrichment:
      auto_enrich:
        enabled: false

    💬 Have feedback or questions? Drop into our discord!

  3. flyingrobots commented on Jun 24, 2026

    @flyingrobots
    OwnerAuthor

    Closing as satisfied/obsolete after the release-surface cleanup and Node retirement. The README now has the current codec-plan release surface, the old runtime-node package matrix row is gone, and operator/release guidance points at the Rust-native preflight/release-check path. Evidence: README.md, docs/ENTRYPOINTS.md, docs/LEGACY_NODE_MIGRATION.md, and PR #619 validation.

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

    legend:DXDeveloper experience worktriage:bad-codeDebt intake that still needs scheduling, closure, or a repo move

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions