Skip to content

docs: add banner and restructure the README#30

Merged
MaximeGaudin merged 1 commit into
gladiaio:mainfrom
MaximeGaudin:docs/readme-banner
Jul 7, 2026
Merged

docs: add banner and restructure the README#30
MaximeGaudin merged 1 commit into
gladiaio:mainfrom
MaximeGaudin:docs/readme-banner

Conversation

@MaximeGaudin

@MaximeGaudin MaximeGaudin commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

What

Adds a banner image and restructures the README so the CLI's value is obvious in the first few seconds.

Banner

A self-contained SVG (docs/assets/readme-banner.svg) in Gladia's navy/cyan identity: an audio waveform flowing into a terminal that shows a diarized transcript. No external assets, no fonts — renders as a static image on GitHub and animates subtly where SVG animation is allowed.

banner

README

  • Badges: build, latest release, license, Go version
  • A one-line value proposition + feature bullets (languages, diarization, output formats, files/URLs, zero config)
  • A "Start here" nav and a Quick start that gets to a transcript in four lines
  • An Everyday examples block, including pipe-friendly -o json | jq
  • Shell-completion instructions collapsed into <details> so the page stays scannable

Every existing detail — commands, transcribe flags, the language matrix, and diarization guidance — is preserved, just reorganized. Usage examples now call gladia (on PATH after the installer) rather than ./gladia.

Notes

Docs-only change; no code touched. Happy to tweak wording, colors, or the tagline to match your brand guidelines.

Summary by CodeRabbit

  • Documentation
    • Reorganized the README for easier navigation and a clearer getting-started flow.
    • Added a banner, badges, and a new “Start here” quick navigation row.
    • Replaced scattered setup/usage content with a streamlined quick start and everyday examples.
    • Updated command, flag, language, and diarization descriptions for clarity.
    • Reformatted shell completion instructions into expandable sections.
    • Updated the footer to include copyright attribution.

Add an SVG banner (audio waveform → diarized transcript, in Gladia's
navy/cyan identity) and reorganize the README around it:

- badges (build, release, license, Go version)
- a one-line value prop and feature bullets
- a "Start here" nav and a Quick start section
- an everyday-examples block, plus pipe-friendly usage
- shell completion collapsed into <details> to keep the page scannable

All commands, flags, and language/diarization guidance are preserved.
@coderabbitai

coderabbitai Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 8973db9e-0632-4234-96d0-257f5c9f3f95

📥 Commits

Reviewing files that changed from the base of the PR and between 22ddae7 and 1e2617e.

⛔ Files ignored due to path filters (1)
  • docs/assets/readme-banner.svg is excluded by !**/*.svg
📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

README.md was restructured with new banner/badges, a condensed introduction, a consolidated "Quick start" section replacing prior Setup/Usage/Examples sections, updated Commands/Flags/Language/Diarization wording, collapsible shell completion blocks, and an updated license footer attribution.

Changes

README documentation restructure

Layer / File(s) Summary
Intro, badges, and quick start
README.md
Adds banner/badges, condensed product overview, "Start here" navigation, and replaces prior Setup/Usage/Examples flow with "Quick start" and "Everyday examples" sections.
Commands, flags, language, and diarization docs
README.md
Reworks Commands and Flags tables, updates Language section phrasing, and rewrites Diarization section intro/heading.
Shell completion and license footer
README.md
Reformats Shell completion into collapsible <details> blocks per shell and updates the license footer to add "© Gladia" attribution.

Estimated code review effort: 1 (Trivial) | ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main documentation change: adding a banner and restructuring the README.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@MaximeGaudin MaximeGaudin merged commit 620e728 into gladiaio:main Jul 7, 2026
6 checks passed
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.

2 participants