Skip to content

docs(readme): refresh header and badges - #402

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:20

@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 README refresh (inline logo in the title, badge reorder, new License section matching AGPL-3.0-only). Nothing blocking.

Findings

  • minor README.md:3: align="absmiddle" is a non-standard value (legacy Netscape, not in HTML4/HTML5). GitHub passes it through today, but spec-following renderers and other Markdown viewers ignore it, so the icon can end up misaligned with the heading text. Suggested: <h1><img src=".github/logo.svg" alt="" width="48" height="48" align="middle"> Stashden</h1>
  • suggestion .github/logo.svg:1: the file is a byte-for-byte copy of site/public/favicon.svg, which the README referenced before this change. Two copies of the brand mark will drift when one is updated. Either drop .github/logo.svg and keep src="site/public/favicon.svg", or note in one of them that the two must stay in sync.

Formal verification

Property Result
none nothing to prove

No executable code changed. README.md (markup, badge order, License section) and .github/logo.svg (static asset not served or parsed by Stashden) were not verified, as there is no behaviour to prove. No harnesses or counterexamples.

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