Skip to content

doc: Refine README content for clarity and consistency - #64

Merged
catinspace-au merged 1 commit into
mainfrom
catinspace-au-patch-1
Oct 7, 2026
Merged

catinspace-au merged 1 commit into
mainfrom
catinspace-au-patch-1

Conversation

@catinspace-au

Copy link
Copy Markdown
Contributor

Updated wording for clarity and consistency throughout the README, including changes to examples and descriptions of features.

Summary

Test plan

  • Unit tests pass locally (pytest tests/unit/ -q)
  • docker build -t culvert:test . succeeds
  • E2E tests pass (if Docker + test VM available)

Checklist

  • Commit messages follow conventional-commits (fix:, feat:, docs:, etc.)
  • Docs updated if user-facing behaviour or configuration changes
  • No internal URLs, hostnames, or HyperI-specific defaults introduced

Updated wording for clarity and consistency throughout the README, including changes to examples and descriptions of features.
@catinspace-au
catinspace-au requested a review from a team as a code owner October 7, 2026 02:18
@catinspace-au
catinspace-au merged commit 76ccb8d into main Oct 7, 2026
11 of 12 checks passed
@catinspace-au
catinspace-au deleted the catinspace-au-patch-1 branch October 7, 2026 02:21
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