Skip to content

docs: refresh release, roadmap, and contributor references #38

Description

@abhiksark

Motivation

Public documentation still points contributors to the completed 0.3.0 roadmap and presents v0.4.0 as current even though the package is now 0.4.1. That creates avoidable confusion for new contributors and learners.

Current evidence

  • Readme.md says Status: v0.4.0 and calls the 0.3.0 roadmap the current focus.
  • pyproject.toml declares version 0.4.1 and requires-python = ">=3.9".
  • Historical design records may intentionally mention past releases, so they need a narrower treatment than public contributor references.

Exact scope

Refresh public release, roadmap, and contributor references so they describe the present project accurately without rewriting historical plans. Make release-command examples version-neutral and preserve the Python 3.9+ compatibility guidance.

Acceptance checklist

  • Remove the completed 0.3.0 roadmap as the current contribution focus and point contributors to the current sprint/backlog reference.
  • Replace hard-coded current v0.4.0 copy in public documentation with version-neutral wording or the actual current version where a version is necessary.
  • Make release examples use placeholders such as vMAJOR.MINOR.PATCH instead of a past release tag.
  • Preserve clear Python 3.9+ runtime compatibility guidance.
  • Correct stale project-name and broken contributor-reference links encountered in the public docs.

Explicit exclusions

Do not rewrite historical plans or release notes merely because they mention past versions, change package metadata, or promise a release.

Likely files

  • Readme.md
  • docs-site/roadmap.md
  • docs-site/contributing.md
  • docs/roadmap/0.3.0.md (archive or redirect treatment only, if needed)

Verification

mkdocs build --strict
rg -n "Status: `v0\.4\.0`|current focus is the.*0\.3\.0|v0\.1\.0" Readme.md docs-site docs/roadmap

Manually check all changed contributor and roadmap links.

Sprint coordination

See the sprint Discussion. This issue is unassigned and is not a reservation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: communityCommunity, outreach, and repository governancedev sprintPythonlings Community Dev Sprint August 2026documentationImprovements or additions to documentationenhancementNew feature or requestgood first issueGood for newcomershelp wantedExtra attention is neededsize: SSmall, focused contribution

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions