Release Relay 0.1.2 with a personal project voice - #9
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
This release rewrites Relay's public-facing documentation in a direct, personal maintainer voice. The README now explains why I built Relay and narrates how an analysis moves from source discovery to findings and timing estimates. Tutorials, architecture, configuration, timing, limitations, security, support, contribution, conduct, roadmap, and GitHub templates received the same focused treatment.
Why
The project was technically clear but sounded institutional. This update makes it read like a thoughtfully maintained personal open-source project while keeping commands, rules, compatibility statements, and safety boundaries concise and precise.
User impact
This is a documentation-focused 0.1.2 release. Analyser rules, report schemas, the public Python API, and CLI behaviour are unchanged from 0.1.1.
Validation
python -m pytest— 37 passedpython -m ruff check .— passedpython -m ruff format --check .— 44 files cleanpython -m mypy— strict checks passed for 14 source filesrelay --version,relay check examples --fail-on critical, andrelay doctor examples— passed