Skip to content

docs: redesign README with custom visuals#19

Merged
sofq merged 1 commit intomainfrom
docs/redesign-readme
Apr 7, 2026
Merged

docs: redesign README with custom visuals#19
sofq merged 1 commit intomainfrom
docs/redesign-readme

Conversation

@sofq
Copy link
Copy Markdown
Owner

@sofq sofq commented Apr 7, 2026

Summary

  • Hand-crafted SVG banner (light + dark), logo, and divider built around a conduit/compression metaphor — violet stream narrows through 4 apertures into a tight green output beam, mirroring how --preset / --fields / --jq compress Confluence responses for agents.
  • Adds a Mermaid mental-model diagram showing cf as the deterministic narrow channel between an AI agent and the Confluence REST API.
  • Restructures content: 6-icon feature grid, flat install list (npm/pip first), workflow use-case table, command + flag reference, exit-code contract, configuration profiles, security layers, and agent integration.

Test plan

  • Banner renders correctly in both light and dark GitHub themes
  • All SVG assets load (.github/readme/banner*.svg, logo.svg, divider.svg, 6 feature icons)
  • Mermaid mental-model diagram renders on GitHub
  • All install commands work as documented
  • All anchor links in the inline TOC resolve

Hand-crafted SVG banner (light + dark), logo, and divider built around
a conduit/compression metaphor. Adds a Mermaid mental-model diagram,
6-icon feature grid, install matrix, and a unified structure for
commands, configuration, security, and agent integration.
@sofq sofq merged commit 2f98a53 into main Apr 7, 2026
12 checks passed
@sofq sofq deleted the docs/redesign-readme branch April 7, 2026 15:12
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 7, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

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