Skip to content

Refresh README, docs intro, and site tagline to match current scope - #138

Merged
luksow merged 1 commit into
mainfrom
docs/refresh-readme-tagline
Sep 8, 2026
Merged

luksow merged 1 commit into
mainfrom
docs/refresh-readme-tagline

Conversation

@luksow

@luksow luksow commented Sep 8, 2026 •

Copy link
Copy Markdown
Contributor

Summary

The tagline in the README, docs intro, and Docusaurus config still said "Generate OpenAPI, HTML Docs or TypeScript client interface from routing tests". That describes three output formats and only routes you serve. Baklava now ships seven formats and documents remote APIs via sttp.

  • Replace the tagline everywhere with: Turn your HTTP tests into OpenAPI, HTML docs, Postman collections, and typed TypeScript or Scala clients, for APIs you serve or consume.
  • README Output Formats section now describes ts-fetch, sttp-client, and Postman, which were missing.
  • SwaggerUI mentions now include baklava-http4s-routes next to the Pekko routes module (README and docs; the docs section dropped its stale "Pekko HTTP only" heading).
  • README Documentation list links the sttp docs page.
  • Docs intro lists all seven output formats and mentions consumed APIs.

Alongside this PR the GitHub About was updated to the same tagline, the homepage now points at the docs site, and topics were refreshed (removed akka; added sttp, munit, postman, orpc, ts-rest, api-documentation, scala3).

Test plan

  • Docs-only change; CI builds the website from docs/ and website/docusaurus.config.ts
  • Skim the rendered README on the PR branch

🤖 Generated with Claude Code

https://claude.ai/code/session_01PVxwHx3cgHXYSKxixdkroY

The tagline still described three output formats and only routes you serve.
Baklava now ships seven formats (OpenAPI, Simple HTML, TS-REST, oRPC,
ts-fetch, sttp-client, Postman) and documents remote APIs via sttp.

- Replace the tagline in README, docs intro, and the Docusaurus config
- Describe the three missing formats in the README Output Formats section
- Mention baklava-http4s-routes alongside the Pekko routes module for SwaggerUI
- Link the sttp docs page from the README
- Drop the stale "Pekko HTTP only" qualifier from the SwaggerUI docs section

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01PVxwHx3cgHXYSKxixdkroY
@luksow
luksow merged commit 06cca0c into main Sep 8, 2026
13 checks passed
@luksow
luksow deleted the docs/refresh-readme-tagline branch September 8, 2026 12:30
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