Update documentation with new tagline and Swagger UI screenshot #148

bufferings · 2025-10-17T15:36:33Z

Updated VitePress config and landing pages to reflect the new tagline. Added Swagger UI screenshot to demonstrate OpenAPI documentation feature.

Summary by CodeRabbit

Documentation
- Updated product branding and messaging across all documentation
- Refreshed guide examples with updated API patterns
- Expanded feature descriptions to highlight multi-library validation support
- Added new features: Structured Logging and Built on Web Standards
- Enhanced API documentation with Swagger UI reference

changeset-bot · 2025-10-17T15:36:36Z

⚠️ No Changeset found

Latest commit: 237cc54

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

coderabbitai · 2025-10-17T15:36:58Z

Walkthrough

Updates VitePress configuration to remove "(WIP)" from project title and refresh tagline descriptions. Modifies documentation guides and index pages in both English and Japanese, replacing enableZodRequestValidation() with enableZodRequestAndResponseValidation(), updating API examples, adjusting response status codes, and reorganizing feature descriptions.

Changes

Cohort / File(s)	Summary
VitePress Configuration `docs/.vitepress/config.js`	Removes "(WIP)" from titles across root and locale configs (en, ja). Updates descriptions to emphasize type safety flow from schemas to validation.
English Documentation `docs/en/guide/what-is-kori.md`, `docs/en/index.md`	Replaces deprecated Zod validation method, updates OpenAPI examples, changes response status to 201 with numeric id, removes schema constraints. Reorganizes features, adds "Structured Logging" and "Built on Web Standards."
Japanese Documentation `docs/ja/guide/what-is-kori.md`, `docs/ja/index.md`	Mirrors English guide updates (validation method swap, example code adjustments). Updates hero text, reorders features with Japanese translations, adds "構造化ログ" and "Web標準ベース."

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Comprehensive documentation improvements #89 — Modifies the same documentation files with overlapping updates to VitePress config, guide examples, and validation method replacements.
Update docs and examples to reflect current API #142 — Updates documentation examples for Zod/OpenAPI validation with similar changes to response status keys and validation API usage.
Add Japanese documentation #110 — Modifies the same VitePress configuration file for structural and metadata updates.

Poem

🐰 Kori shed its (WIP) coat today,
Features leap and dance in fresh array—
From schema to safety, the types flow free,
Documentation blooms in harmony!
English, Japanese—both voices sing,
Of validated flows and everything. 🌸

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title "Update documentation with new tagline and Swagger UI screenshot" is directly related to the main changes described in the PR objectives. The changeset clearly reflects both elements: the VitePress configuration and documentation files have been updated with the new tagline ("Type safety in your flow - From schemas to types, validation, and docs"), and the guide documents include references to Swagger UI screenshots. The title is concise, specific, and clearly conveys the primary purpose from the developer's perspective. While the changeset includes additional updates such as API signature changes and feature documentation refinements, the title appropriately captures the stated main objectives without unnecessary detail.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch work

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2ac9278 and 237cc54.

⛔ Files ignored due to path filters (1)

docs/public/swagger-ui.png is excluded by !**/*.png

📒 Files selected for processing (5)

docs/.vitepress/config.js (1 hunks)
docs/en/guide/what-is-kori.md (1 hunks)
docs/en/index.md (2 hunks)
docs/ja/guide/what-is-kori.md (1 hunks)
docs/ja/index.md (2 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

**/docs/**/*.md

📄 CodeRabbit inference engine (.cursor/rules/docs.mdc)

**/docs/**/*.md: Never write documentation based on assumptions or guesswork; always read and understand the actual source code before writing documentation, including reading main API functions, type definitions, and existing examples, verifying all code examples work with the actual implementation, basing method signatures and behaviors on real source code, and checking test files for usage patterns.
Use clear heading hierarchy and natural prose instead of bold text for emphasis; use descriptive subheadings and logical organization, complete sentences that flow naturally, and avoid bold text for emphasis except for critical warnings.
Start documentation with the simplest working example, focus on the essential value proposition, let code examples do the explaining, and keep explanatory text concise.
State capabilities factually without overselling, avoid negative comparisons with other frameworks, never fabricate testimonials or quotes, and be positive but realistic about limitations.
Inaccurate documentation is worse than no documentation. Always verify against source code.

Files:

docs/ja/guide/what-is-kori.md
docs/ja/index.md
docs/en/index.md
docs/en/guide/what-is-kori.md

**/*.{md,mdc}

📄 CodeRabbit inference engine (.cursor/rules/coding.mdc)

Documentation markdown files may use non-ASCII characters freely

Files:

docs/ja/guide/what-is-kori.md
docs/ja/index.md
docs/en/index.md
docs/en/guide/what-is-kori.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: build-and-test

🔇 Additional comments (8)

docs/en/index.md (2)

6-7: LGTM! Clear and concise tagline.

The updated hero text and tagline effectively communicate the framework's value proposition.

17-28: Well-structured feature descriptions.

The feature list is logically organized and uses clear, factual language without overselling. The descriptions effectively communicate the framework's capabilities.

docs/.vitepress/config.js (1)

4-5: LGTM! Consistent branding across locales.

The configuration updates are consistent across all locales and align with the landing page updates. The removal of "(WIP)" indicates production readiness.

Also applies to: 13-14, 19-20

docs/ja/index.md (1)

6-7: LGTM! Consistent Japanese localization.

The Japanese content mirrors the English version appropriately, maintaining consistency across locales.

Also applies to: 17-28

docs/en/guide/what-is-kori.md (3)

76-77: Verify schema simplification is intentional.

The request schema has been simplified by removing .min(1) and .int().min(0) constraints, and the response schema has changed from status '200' with string id to status '201' with numeric id. While status 201 is more semantically correct for POST requests (indicating resource creation), ensure these changes accurately reflect the actual API behavior and aren't just simplifications that could mislead users.

Based on learnings

Also applies to: 81-84

96-96: Image file verified to exist — no action required.

The script confirms that swagger-ui.png exists at docs/public/swagger-ui.png. The markdown reference to /swagger-ui.png correctly resolves to this file in a typical static site generator setup where /public contents are served at the root.

66-66: 

The API method name is correct.

The function enableZodRequestAndResponseValidation() has been verified to exist in the codebase at packages/zod-schema-adapter/src/zod-enable-validation/enable-zod-request-and-response-validation.ts. The documentation example is accurate for this API.

docs/ja/guide/what-is-kori.md (1)

66-66: Consistent with English version - same verification needed.

The Japanese guide mirrors the API changes in the English version (docs/en/guide/what-is-kori.md). The same verification concerns apply:

API method name enableZodRequestAndResponseValidation()

Schema simplification and status code changes

Swagger UI image reference

Please ensure the verifications requested for the English version are also confirmed for this Japanese version.

Also applies to: 76-77, 81-84, 96-96

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 and usage tips.}

Copilot

Pull Request Overview

Updates the documentation to reflect the new product tagline and showcases the OpenAPI/Swagger UI integration.

Refreshes hero text/tagline across English and Japanese landing pages
Adds Swagger UI screenshot to guides and updates example code to show response validation and 201 status
Aligns VitePress site metadata (title/description) with the new messaging

Reviewed Changes

Copilot reviewed 5 out of 6 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
docs/ja/index.md	Updates hero copy and feature bullets in Japanese to match the new positioning.
docs/ja/guide/what-is-kori.md	Updates example to include response validation, 201 status, and adds Swagger UI screenshot; adds docs link.
docs/en/index.md	Updates hero copy and feature bullets in English to match the new positioning.
docs/en/guide/what-is-kori.md	Updates example to include response validation, 201 status, and adds Swagger UI screenshot; adds docs link.
docs/.vitepress/config.js	Aligns site title/description (global and per-locale) with the new tagline.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-17T15:37:41Z

docs/en/index.md

+    details: Built on Hono's proven router - fast, lightweight, and production-ready. Focus on your business logic while the routing engine handles performance.
  - title: Schema-Driven Development
-    details: One Zod schema powers validation, TypeScript types, and OpenAPI documentation. Change once, update everywhere automatically.
+    details: One Zod schema powers validation, TypeScript types, and OpenAPI documentation. Other Standard Schema libraries supported for validation and types.


Grammar fix: add the missing verb 'are' to read 'Other Standard Schema libraries are supported for validation and types.'

Suggested change

details: One Zod schema powers validation, TypeScript types, and OpenAPI documentation. Other Standard Schema libraries supported for validation and types.

details: One Zod schema powers validation, TypeScript types, and OpenAPI documentation. Other Standard Schema libraries are supported for validation and types.

Copilot · 2025-10-17T15:37:41Z

docs/en/guide/what-is-kori.md

 ```

-[Image placeholder: Interactive OpenAPI documentation generated from UserSchema]
+Now you can visit http://localhost:3000/docs for interactive API documentation.


Use a Markdown link so the URL is clickable in all renderers: http://localhost:3000/docs.

Suggested change

Now you can visit http://localhost:3000/docs for interactive API documentation.

Now you can visit [http://localhost:3000/docs](http://localhost:3000/docs) for interactive API documentation.

Copilot · 2025-10-17T15:37:41Z

docs/ja/guide/what-is-kori.md

 ```

-[画像プレースホルダー: UserSchemaから生成されたインタラクティブなOpenAPIドキュメント]
+http://localhost:3000/docs にアクセスすると、インタラクティブなAPIドキュメントが表示されます。


Use a Markdown link so the URL is clickable in all renderers: http://localhost:3000/docs。

Suggested change

http://localhost:3000/docs にアクセスすると、インタラクティブなAPIドキュメントが表示されます。

[http://localhost:3000/docs](http://localhost:3000/docs) にアクセスすると、インタラクティブなAPIドキュメントが表示されます。

Update documentation with new tagline and Swagger UI screenshot

237cc54

Copilot AI review requested due to automatic review settings October 17, 2025 15:36

Copilot AI reviewed Oct 17, 2025

View reviewed changes

bufferings merged commit 3b1eab8 into main Oct 17, 2025
2 checks passed

bufferings deleted the work branch October 17, 2025 15:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update documentation with new tagline and Swagger UI screenshot #148

Update documentation with new tagline and Swagger UI screenshot #148

Uh oh!

bufferings commented Oct 17, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

changeset-bot bot commented Oct 17, 2025

Uh oh!

coderabbitai bot commented Oct 17, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Oct 17, 2025

Uh oh!

Copilot AI Oct 17, 2025

Uh oh!

Copilot AI Oct 17, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	details: One Zod schema powers validation, TypeScript types, and OpenAPI documentation. Other Standard Schema libraries supported for validation and types.
	details: One Zod schema powers validation, TypeScript types, and OpenAPI documentation. Other Standard Schema libraries are supported for validation and types.

	Now you can visit http://localhost:3000/docs for interactive API documentation.
	Now you can visit [http://localhost:3000/docs](http://localhost:3000/docs) for interactive API documentation.

	http://localhost:3000/docs にアクセスすると、インタラクティブなAPIドキュメントが表示されます。
	[http://localhost:3000/docs](http://localhost:3000/docs) にアクセスすると、インタラクティブなAPIドキュメントが表示されます。

Update documentation with new tagline and Swagger UI screenshot #148

Update documentation with new tagline and Swagger UI screenshot #148

Uh oh!

Conversation

bufferings commented Oct 17, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

changeset-bot bot commented Oct 17, 2025

⚠️ No Changeset found

Uh oh!

coderabbitai bot commented Oct 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Poem

Pre-merge checks and finishing touches

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

bufferings commented Oct 17, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Oct 17, 2025 •

edited

Loading