Skip to content

docs(readme): refresh header and badges, fix stale content - #341

Merged
BryanFRD merged 1 commit into
mainfrom
docs/readme-refresh
Oct 31, 2026
Merged

BryanFRD merged 1 commit into
mainfrom
docs/readme-refresh

Conversation

@BryanFRD

Copy link
Copy Markdown
Contributor

Standard header: logo next to the name, badges that actually render, links. README checked against the code, stale content fixed. Docs only.

Signed-off-by: BryanFRD <bryanferrando59@gmail.com>
@BryanFRD
BryanFRD enabled auto-merge (squash) October 31, 2026 11:19

@ferrfleet-interne ferrfleet-interne Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approve. Docs-only refresh of README.md plus a new .github/logo.svg. The code review checked it against the repo at 4423650 and found the directories, ci.yml, tag schemes (v*, cli-v*, mcp-v*), release artifacts and sub-READMEs all match what the new text says. Nothing blocking.

Findings

  • minor, README.md:27: the action row lists v* tags, which is right, but action/README.md (not touched here) tells users to write uses: FerrLabs/FerrVault/action@v1. No v1 git tag exists, only full semver tags such as v6.1.4. The v{major} entry in .ferrflow is a Docker image tag, not a git tag. Because this README now points readers to action/README.md, they will hit a ref that does not resolve. Suggested follow-up: publish a moving v{major} git tag from the release workflow (the usual pattern for Actions), or change the example to a full tag.
  • suggestion, README.md:3: align="absmiddle" is a legacy value that is not in the HTML spec, and browsers may render it differently. Use align="center" or align="top":
    <h1><img src=".github/logo.svg" alt="" width="48" height="48" align="center"> FerrVault</h1>

Formal verification

Nothing to prove. The change is documentation and a static SVG with no executable code, so no harnesses were generated and there are no counterexamples.

@BryanFRD
BryanFRD merged commit ea05295 into main Oct 31, 2026
20 checks passed
@BryanFRD
BryanFRD deleted the docs/readme-refresh branch October 31, 2026 11:38
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