Skip to content

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

Merged
BryanFRD merged 2 commits into
mainfrom
docs/readme-refresh
Oct 31, 2026
Merged

BryanFRD merged 2 commits 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
Contributor

Choose a reason for hiding this comment

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

Changes requested. The FerrFleet row in profile/README.md was garbled while removing the em dash, and it is on the public org page.

Blocking

  • profile/README.md:24: FerrFleet description is garbled. It now reads "shows you what they actually X plus observability". The cleanup dropped the words "did" and "execution". Suggested fix:
    | **FerrFleet** | Runs your AI agents and shows you what they actually did: execution plus observability. | [ferrfleet.com](https://ferrfleet.com) |

Suggestions

  • .github/logo.svg:3: the logo text depends on a font that will not load. SVGs rendered through <img> cannot load web fonts, so Fraunces never applies. The mark falls back to Georgia or the system serif, which varies by platform. Reuse workflow-templates/ferrlabs.svg, which already exists, or outline the "FL" glyphs as paths.

Checked and fine

  • The reusable workflow list and starter template list in README.md match the files in .github/workflows/ and workflow-templates/. CodeQL was removed from the template list because no such template exists.
  • The "16 file formats" count for FerrFlow was not checked, since that code is in another repository.

Formal verification

Nothing to prove. The change is Markdown and a static SVG with no executable behavior, so no harness or property applies. No counterexamples.

Property Result
None applicable nothing_to_prove

Signed-off-by: BryanFRD <bryanferrando59@gmail.com>

@ferrfleet-interne ferrfleet-interne Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Approve. Docs-only refresh (README, org profile, new logo). Nothing blocking; two minor suggestions.

Suggestions

  • .github/logo.svg:3: SVGs loaded through <img> cannot fetch web fonts, so Fraunces never applies and the "FL" text renders in Georgia or whatever serif the viewer has. Glyphs and kerning will differ between platforms. Convert the text to paths for a consistent logo, or accept the fallback.
  • profile/README.md:3: the logo URL points at raw.githubusercontent.com/FerrLabs/.github/main/.github/logo.svg, which returns 404 until this PR lands on main. Expected, since the profile renders from main. It only affects previews of this branch. No change needed.

Checked

  • The reusable-workflow and starter-template lists in README.md match .github/workflows/ and workflow-templates/ at e8bf1d5. The removed CodeQL entry has no template file.
  • LICENSE exists for the new badge.
  • The "16 file formats" and FerrFlow@v7 claims match FerrFlow's README.

Formal verification

Nothing to prove: the changes are documentation and a static SVG with no executable logic. No harnesses, counterexamples or issues.

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