Skip to content

docs(website): update message#1381

Open
shabaraba wants to merge 2 commits intomainfrom
docs/update-docs
Open

docs(website): update message#1381
shabaraba wants to merge 2 commits intomainfrom
docs/update-docs

Conversation

@shabaraba
Copy link
Member

@shabaraba shabaraba commented Mar 4, 2026

Why

cli-kintone has evolved from a simple record import/export tool to an all-in-one CLI that supports:

  • Record operations (import, export, delete)
  • Plugin development (init, package, upload)
  • JavaScript/CSS customization management

The current website messaging and documentation still describe cli-kintone as "The CLI tool for importing and exporting Kintone records", which no longer reflects the full capabilities of the tool.

What

Updated messaging across the website and documentation:

File Change
docusaurus.config.ts Updated tagline to "The command line interface for Kintone"
src/pages/index.tsx Updated title, description, and tagline
HomepageFeatures/index.tsx Replaced "Attachment field support" with "All-in-one Kintone CLI" feature
i18n/ja/code.json Updated Japanese translations for tagline, description, and features
docs/guide/index.mdx Expanded "What is cli-kintone?" section with plugin and customization info
i18n/ja/.../guide/index.mdx Updated Japanese guide with same expanded description
package.json Updated npm package description
README.md Updated repository description
static/img/undraw_data_at_work.svg Added new illustration for "All-in-one" feature

How to test

  1. Run pnpm doc:build to build the website
  2. Run pnpm doc:serve to preview the built site
  3. Check the homepage in both English (/) and Japanese (/ja/)
  4. Verify the "What is cli-kintone?" section in the guide

Checklist

  • Read CONTRIBUTING.md
  • Updated documentation if it is required.
  • Added tests if it is required.
  • Passed pnpm lint and pnpm test on the root directory.

@shabaraba shabaraba requested a review from a team as a code owner March 4, 2026 05:02
@shabaraba shabaraba requested review from chihiro-adachi, Copilot and nameless-mc and removed request for a team March 4, 2026 05:02
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the website and top-level project metadata to reflect that cli-kintone is now an all-in-one CLI for Kintone (record operations, plugin development, and JavaScript/CSS customization), rather than only an import/export tool.

Changes:

  • Refreshes homepage tagline/title/description and replaces a homepage feature to highlight “All-in-one Kintone CLI”.
  • Expands the “What is cli-kintone?” guide section (EN/JA) to include plugin development and customization workflows.
  • Updates package/repo descriptions and adds a new homepage illustration.

Reviewed changes

Copilot reviewed 8 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
website/docusaurus.config.ts Updates the site tagline to the new positioning.
website/src/pages/index.tsx Updates homepage tagline + SEO title/description strings.
website/src/components/HomepageFeatures/index.tsx Replaces one feature card content and swaps the feature SVG.
website/i18n/ja/code.json Updates Japanese translations for homepage strings/features.
website/docs/guide/index.mdx Expands “What is cli-kintone?” section to cover broader capabilities.
website/i18n/ja/docusaurus-plugin-content-docs/current/guide/index.mdx Mirrors the guide expansion in Japanese.
package.json Updates npm package description.
README.md Updates repository short description.
website/static/img/undraw_data_at_work.svg Adds a new illustration used on the homepage feature card.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Comment on lines +18 to +28
cli-kintoneは、Kintone のカスタマイズとデータ管理のためのCLIツールです。

- **レコード操作** — Kintone レコードの一括インポート、エクスポート、削除
- Kintone レコードのバックアップ/リストア
- Kintone と BI プラットフォーム間のデータ同期
- 他システムからのデータ移行
- **プラグイン開発** — Kintone プラグインの初期化、パッケージング、アップロード
- テンプレートから新しいプラグインプロジェクトを作成
- プラグインをパッケージ化して Kintone 環境にデプロイ
- **JavaScript/CSS カスタマイズ** — アプリカスタマイズファイルの管理
- Kintone アプリに JavaScript/CSS カスタマイズを適用
Copy link

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

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

In this updated section, the product name is written as "Kintone" (with an extra space before particles like "Kintone の"), while the rest of this document uses "kintone" (e.g., later sections). To keep terminology consistent in the Japanese guide, consider using the same casing/spelling throughout (and remove the extra spaces if not intentional).

Suggested change
cli-kintoneは、Kintone のカスタマイズとデータ管理のためのCLIツールです
- **レコード操作**Kintone レコードの一括インポート、エクスポート、削除
- Kintone レコードのバックアップ/リストア
- Kintone と BI プラットフォーム間のデータ同期
- 他システムからのデータ移行
- **プラグイン開発**Kintone プラグインの初期化、パッケージング、アップロード
- テンプレートから新しいプラグインプロジェクトを作成
- プラグインをパッケージ化して Kintone 環境にデプロイ
- **JavaScript/CSS カスタマイズ** — アプリカスタマイズファイルの管理
- Kintone アプリに JavaScript/CSS カスタマイズを適用
cli-kintoneは、kintoneのカスタマイズとデータ管理のためのCLIツールです
- **レコード操作**kintone レコードの一括インポート、エクスポート、削除
- kintone レコードのバックアップ/リストア
- kintone と BI プラットフォーム間のデータ同期
- 他システムからのデータ移行
- **プラグイン開発**kintone プラグインの初期化、パッケージング、アップロード
- テンプレートから新しいプラグインプロジェクトを作成
- プラグインをパッケージ化して kintone 環境にデプロイ
- **JavaScript/CSS カスタマイズ** — アプリカスタマイズファイルの管理
- kintone アプリに JavaScript/CSS カスタマイズを適用

Copilot uses AI. Check for mistakes.
Comment on lines +560 to +591
@@ -575,11 +575,11 @@
"homepage.features.easyToUse.description": {
"message": "cli-kintone はIT担当者やエンジニア以外の方でも使えるように設計されています。すぐに慣れることができます。"
},
"homepage.features.attachmentSupport.title": {
"message": "添付ファイルフィールド対応"
"homepage.features.allInOne.title": {
"message": "オールインワン Kintone CLI"
},
"homepage.features.attachmentSupport.description": {
"message": "cli-kintone は添付ファイルフィールドに対応しています。Kintone レコードと一緒にファイルをダウンロードまたはアップロードできます。"
"homepage.features.allInOne.description": {
"message": "レコード操作、プラグイン開発、JavaScript/CSS カスタマイズ — すべてを1つのツールで。"
},
"homepage.features.automation.title": {
"message": "自動化に最適"
@@ -588,7 +588,7 @@
"message": "cli-kintone はシェルスクリプトとの連携に優れています。定期的な作業や日常業務を自動化できます。"
},
"homepage.title": {
"message": "cli-kintone; Kintone レコードをインポート・エクスポートするCLIツール",
"message": "cli-kintone - Kintone のコマンドラインインターフェース",
Copy link

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

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

Japanese homepage strings use "Kintone の…" with a space and capitalized "Kintone". If the preferred product spelling in Japanese docs is "kintone" (as used elsewhere in the guide), consider aligning these translations to the same casing/spacing for consistency across the site.

Copilot uses AI. Check for mistakes.
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