diff --git a/app/layout.config.tsx b/app/layout.config.tsx index b0351be2..b660ce1c 100644 --- a/app/layout.config.tsx +++ b/app/layout.config.tsx @@ -18,6 +18,10 @@ export function baseOptions(locale: string): BaseLayoutProps { }, // see https://fumadocs.dev/docs/ui/navigation/links links: [ + { + text: customTranslations[locale]['guides.title'], + url: '/guides/sheets', + }, { text: customTranslations[locale]['reference.title'], url: '/reference/classes/univer', diff --git a/content/guides/changelog.ja-JP.mdx b/content/guides/changelog.ja-JP.mdx new file mode 100644 index 00000000..9e9f353d --- /dev/null +++ b/content/guides/changelog.ja-JP.mdx @@ -0,0 +1,52 @@ +--- +title: 変更ログ +--- + +Univer は [セマンティック バージョニング](https://semver.org/lang/ja/)(`MAJOR.MINOR.PATCH`)に従います。 + +- **MAJOR**:互換性のない API 変更 +- **MINOR**:新機能、後方互換性あり +- **PATCH**:バグ修正、後方互換性あり + +## リリース チャンネル + +| チャンネル | 安定性 | 用途 | +|-----------|--------|------| +| 安定版 (`latest`) | 本番環境対応 | 本番デプロイ | +| ベータ版 (`beta`) | 機能完了、テスト中 | 本番前の検証 | +| アルファ版 (`alpha`) | 開発中 | 早期アクセス、フィードバック | +| ナイトリー版 (`nightly`) | 最新コミット | 最先端のテスト | + +npm タグを使用して特定のチャンネルをインストールできます: + +```bash +npm install @univerjs/core@latest +npm install @univerjs/core@beta +npm install @univerjs/core@alpha +npm install @univerjs/core@nightly +``` + +> **重要**:アルファ版、ベータ版、ナイトリー版にはバグや不完全な機能が含まれる可能性があります。本番環境での使用は避けてください。 + +## バージョン履歴 + +すべてのバージョンのリリースノートは [GitHub Releases](https://github.com/dream-num/univer/releases) で公開されています。 + +### アップグレード方法 + +1. 破壊的変更について [リリースノート](https://github.com/dream-num/univer/releases) を確認する +2. すべての `@univerjs/*` パッケージを同じターゲット バージョンに更新する +3. テスト スイートを実行する +4. 問題が発生した場合は、[トラブルシューティング](/guides/troubleshooting) ガイドを参照する + +### 非推奨ポリシー + +- 非推奨としてマークされた機能は、少なくとも 1 つのマイナー バージョンは引き続き動作します +- 非推奨の API は、開発ビルドで警告をログ出力します +- 移行パスはリリースノートに記載されます + +## 最新情報を入手する + +- [GitHub リポジトリ](https://github.com/dream-num/univer) をウォッチしてリリース通知を受け取る +- [ブログ](/blog) をフォローして詳細な機能発表を確認する +- [Discord](https://discord.gg/XPGnMBmpd6) に参加してディスカッションに参加する diff --git a/content/guides/changelog.mdx b/content/guides/changelog.mdx new file mode 100644 index 00000000..fcca0539 --- /dev/null +++ b/content/guides/changelog.mdx @@ -0,0 +1,52 @@ +--- +title: Changelog +--- + +Univer follows [Semantic Versioning](https://semver.org/) (`MAJOR.MINOR.PATCH`). + +- **MAJOR**: Incompatible API changes +- **MINOR**: New features, backwards compatible +- **PATCH**: Bug fixes, backwards compatible + +## Release Channels + +| Channel | Stability | Use Case | +|---------|-----------|----------| +| Stable (`latest`) | Production-ready | Production deployments | +| Beta (`beta`) | Feature-complete, testing | Pre-production validation | +| Alpha (`alpha`) | In development | Early access, feedback | +| Nightly (`nightly`) | Latest commits | Bleeding edge testing | + +You can install a specific channel via npm tags: + +```bash +npm install @univerjs/core@latest +npm install @univerjs/core@beta +npm install @univerjs/core@alpha +npm install @univerjs/core@nightly +``` + +> **Important**: Alpha, beta, and nightly versions may contain bugs or incomplete features. Avoid using them in production. + +## Version History + +Release notes for all versions are published on [GitHub Releases](https://github.com/dream-num/univer/releases). + +### How to Upgrade + +1. Review the [release notes](https://github.com/dream-num/univer/releases) for breaking changes +2. Update all `@univerjs/*` packages to the same target version +3. Run your test suite +4. Check the [Troubleshooting](/guides/troubleshooting) guide if issues arise + +### Deprecation Policy + +- Features marked as deprecated will continue to work for at least one minor version +- Deprecated APIs will log warnings in development builds +- Migration paths are documented in the release notes + +## Staying Informed + +- Watch the [GitHub repository](https://github.com/dream-num/univer) for release notifications +- Follow our [blog](/blog) for in-depth feature announcements +- Join our [Discord](https://discord.gg/XPGnMBmpd6) for discussions diff --git a/content/guides/changelog.zh-CN.mdx b/content/guides/changelog.zh-CN.mdx new file mode 100644 index 00000000..33031e85 --- /dev/null +++ b/content/guides/changelog.zh-CN.mdx @@ -0,0 +1,52 @@ +--- +title: 更新日志 +--- + +Univer 遵循 [语义化版本控制](https://semver.org/lang/zh-CN/)(`MAJOR.MINOR.PATCH`)。 + +- **MAJOR(主版本)**:不兼容的 API 变更 +- **MINOR(次版本)**:新增功能,向后兼容 +- **PATCH(修订版本)**:问题修复,向后兼容 + +## 发布渠道 + +| 渠道 | 稳定性 | 适用场景 | +|------|--------|----------| +| 稳定版 (`latest`) | 生产环境可用 | 生产部署 | +| 测试版 (`beta`) | 功能完整,测试中 | 生产前验证 | +| 预览版 (`alpha`) | 开发中 | 早期体验、反馈 | +| 每夜版 (`nightly`) | 最新提交 | 前沿功能测试 | + +你可以通过 npm 标签安装特定渠道: + +```bash +npm install @univerjs/core@latest +npm install @univerjs/core@beta +npm install @univerjs/core@alpha +npm install @univerjs/core@nightly +``` + +> **重要**:Alpha、Beta 和每夜版可能包含缺陷或未完成的功能,请避免在生产环境中使用。 + +## 版本历史 + +所有版本的发布说明均发布在 [GitHub Releases](https://github.com/dream-num/univer/releases)。 + +### 如何升级 + +1. 查看 [发布说明](https://github.com/dream-num/univer/releases) 了解破坏性变更 +2. 将所有 `@univerjs/*` 包更新到相同的目标版本 +3. 运行你的测试套件 +4. 如遇到问题,请查看 [故障排查](/guides/troubleshooting) 指南 + +### 弃用策略 + +- 标记为弃用的功能至少会再维护一个次版本 +- 弃用的 API 会在开发构建中输出警告 +- 迁移路径会在发布说明中记录 + +## 保持关注 + +- Watch [GitHub 仓库](https://github.com/dream-num/univer) 获取发布通知 +- 关注我们的 [博客](/blog) 了解深度功能公告 +- 加入 [Discord](https://discord.gg/XPGnMBmpd6) 参与讨论 diff --git a/content/guides/changelog.zh-TW.mdx b/content/guides/changelog.zh-TW.mdx new file mode 100644 index 00000000..24e5fb63 --- /dev/null +++ b/content/guides/changelog.zh-TW.mdx @@ -0,0 +1,52 @@ +--- +title: 更新日誌 +--- + +Univer 遵循 [語義化版本控制](https://semver.org/lang/zh-TW/)(`MAJOR.MINOR.PATCH`)。 + +- **MAJOR(主版本)**:不相容的 API 變更 +- **MINOR(次版本)**:新增功能,向後相容 +- **PATCH(修訂版本)**:問題修復,向後相容 + +## 發布渠道 + +| 渠道 | 穩定性 | 適用場景 | +|------|--------|----------| +| 穩定版 (`latest`) | 生產環境可用 | 生產部署 | +| 測試版 (`beta`) | 功能完整,測試中 | 生產前驗證 | +| 預覽版 (`alpha`) | 開發中 | 早期體驗、回饋 | +| 每夜版 (`nightly`) | 最新提交 | 前沿功能測試 | + +你可以透過 npm 標籤安裝特定渠道: + +```bash +npm install @univerjs/core@latest +npm install @univerjs/core@beta +npm install @univerjs/core@alpha +npm install @univerjs/core@nightly +``` + +> **重要**:Alpha、Beta 和每夜版可能包含缺陷或未完成的功能,請避免在生產環境中使用。 + +## 版本歷史 + +所有版本的發布說明均發布在 [GitHub Releases](https://github.com/dream-num/univer/releases)。 + +### 如何升級 + +1. 查看 [發布說明](https://github.com/dream-num/univer/releases) 了解破壞性變更 +2. 將所有 `@univerjs/*` 套件更新到相同的目標版本 +3. 執行你的測試套件 +4. 如遇到問題,請查看 [故障排查](/guides/troubleshooting) 指南 + +### 棄用策略 + +- 標記為棄用的功能至少會再維護一個次版本 +- 棄用的 API 會在開發建置中輸出警告 +- 遷移路徑會在發布說明中記錄 + +## 保持關注 + +- Watch [GitHub 倉庫](https://github.com/dream-num/univer) 取得發布通知 +- 關注我們的 [部落格](/blog) 了解深度功能公告 +- 加入 [Discord](https://discord.gg/XPGnMBmpd6) 參與討論 diff --git a/content/guides/contributing.ja-JP.mdx b/content/guides/contributing.ja-JP.mdx new file mode 100644 index 00000000..e45477a3 --- /dev/null +++ b/content/guides/contributing.ja-JP.mdx @@ -0,0 +1,144 @@ +--- +title: コントリビューションガイド +--- + +Univer へのコントリビューションに興味をお持ちいただき、ありがとうございます!このガイドは、あなたの始め方をお手伝いします。 + +## 行動規範 + +すべてのコントリビューターにとって、フレンドリーで安全、かつ歓迎される環境を提供することをお約束します。すべてのやり取りで、敬意を持ち建設的であってください。 + +## コントリビューションの方法 + +### バグの報告 + +バグ報告を作成する前に、以下を行ってください: + +1. [既存の issue](https://github.com/dream-num/univer/issues) を検索して重複を避ける +2. 最新の安定版を使用してバグがまだ存在することを確認する +3. 関連情報を収集する:ブラウザーのバージョン、Node.js のバージョン、エラーメッセージ + +報告時には以下を含めてください: + +- 明確で説明的なタイトル +- 問題を再現する手順 +- 期待される動作と実際の動作 +- 最小限の再現例(CodeSandbox、StackBlitz、または GitHub リポジトリ) +- 該当する場合は、スクリーンショットや画面録画 + +### 機能の提案 + +機能リクエストは歓迎されます!まずディスカッションを開いて、コミュニティやメンテナーからのフィードバックを集めることをお勧めします。 + +### コードのコントリビューション + +#### 開発環境のセットアップ + +1. リポジトリをフォークしてクローンします: + ```bash + git clone https://github.com/YOUR_USERNAME/univer.git + cd univer + ``` + +2. 依存関係をインストールします: + ```bash + pnpm install + ``` + +3. プロジェクトをビルドします: + ```bash + pnpm build + ``` + +4. テストを実行します: + ```bash + pnpm test + ``` + +#### プロジェクト構造 + +``` +packages/ + core/ # コア インフラストラクチャ(DI、コマンド システム、ライフサイクル) + design/ # デザイン システムと基本スタイル + engine-render/ # Canvas レンダリング エンジン + engine-formula/ # 数式計算エンジン + sheets/ # スプレッドシート データ モデルとコア ロジック + sheets-ui/ # スプレッドシート UI コンポーネント + docs/ # ドキュメント データ モデル + docs-ui/ # ドキュメント UI コンポーネント + slides/ # プレゼンテーション データ モデル + ui/ # 共有 UI フレームワーク +examples/ # 統合例(React、Vue、Angular など) +``` + +#### プラグインの作成 + +Univer はプラグイン アーキテクチャで構築されています。新しい機能を追加するには: + +1. `packages/` の下に新しいパッケージを作成するか、スタンドアロンのリポジトリを作成します +2. `Plugin` を拡張するプラグイン クラスを実装します +3. `onStarting` でコマンド、サービス、コントローラーを登録します +4. 公開 API を公開する場合は、ファサード拡張を追加します +5. テストとドキュメントを作成します + +ステップバイステップのガイドについては、[カスタム プラグイン チュートリアル](/guides/recipes/tutorials/custom-plugin) を参照してください。 + +#### コミット規約 + +[Conventional Commits](https://www.conventionalcommits.org/ja/v1.0.0/) を使用しています: + +``` +(): + + + +