Skip to content

Commit cc53961

Browse files
authored
Prepare documentation site for public launch (#7)
* docs: update landing page Quick Start to match docs workflow - Change step 1: Install → Initialize project (gem install + trc --init) - Change step 2: Create file → Start watch mode (trc --watch) - Change step 3: Compile → Write typed Ruby (src/hello.trb) - Update i18n translations for ko and ja * refactor: update tagline to TypeScript-style "Ruby with syntax for types" - Change hero title from "Type-safe Ruby, the TypeScript way" to "T-Ruby is Ruby with syntax for types." - Update subtitle to mention .rbs output and "Just like TypeScript" - Update all i18n translations (ko, ja) * docs: rename first-trb-file to understanding-trb-files Change document title and filename across all languages: - EN: "Your First .trb File" → "Understanding .trb Files" - KO: "첫 번째 .trb 파일" → ".trb 파일 이해하기" - JA: "最初の.trbファイル" → ".trbファイルを理解する" * feat: redesign homepage with new sections and i18n - Add "What is T-Ruby?" section with 3-column layout - Redesign code showcase with arrow-based transformation flow - Add "Existing Methods" comparison section (Sorbet, RBS, TypeProf, Others) - Add "Join the Journey" GitHub contribution section - Add version banner with changelog link - Add JetBrains to editors list - Update footer copyright with linked author names - Add Japanese and Korean translations for new sections * feat: add experimental notice to contribute section and footer credits
1 parent 7152563 commit cc53961

File tree

16 files changed

+1097
-112
lines changed

16 files changed

+1097
-112
lines changed

docs/getting-started/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,5 +153,5 @@ sudo dnf groupinstall "Development Tools"
153153
Now that T-Ruby is installed, let's write some code:
154154

155155
- [Quick Start](/docs/getting-started/quick-start) - Get running in 5 minutes
156-
- [Your First .trb File](/docs/getting-started/first-trb-file) - A detailed walkthrough
156+
- [Understanding .trb Files](/docs/getting-started/understanding-trb-files) - A detailed walkthrough
157157
- [Editor Setup](/docs/getting-started/editor-setup) - Configure your IDE

docs/getting-started/quick-start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ Here's a summary of the commands you'll use most:
142142

143143
You've written and compiled your first T-Ruby code! Here's where to go next:
144144

145-
1. **[Your First .trb File](/docs/getting-started/first-trb-file)** - A deeper dive into T-Ruby files
145+
1. **[Understanding .trb Files](/docs/getting-started/understanding-trb-files)** - A deeper dive into T-Ruby files
146146
2. **[Editor Setup](/docs/getting-started/editor-setup)** - Get syntax highlighting and autocomplete
147147
3. **[Basic Types](/docs/learn/basics/basic-types)** - Learn the type system
148148

docs/getting-started/first-trb-file.md renamed to docs/getting-started/understanding-trb-files.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
sidebar_position: 3
3-
title: Your First .trb File
4-
description: Create and compile your first T-Ruby file
3+
title: Understanding .trb Files
4+
description: Learn how T-Ruby files work
55
---
66

77
<DocsBadge />
88

99

10-
# Your First .trb File
10+
# Understanding .trb Files
1111

1212
This guide takes you through creating a T-Ruby file step by step, explaining each concept as we go.
1313

docusaurus.config.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import type * as Preset from '@docusaurus/preset-classic';
44

55
const config: Config = {
66
title: 'T-Ruby',
7-
tagline: 'Type-safe Ruby, the TypeScript way',
7+
tagline: 'Ruby with syntax for types.',
88
favicon: 'img/logo.svg',
99

1010
future: {
@@ -199,7 +199,7 @@ const config: Config = {
199199
],
200200
},
201201
],
202-
copyright: `Copyright © ${new Date().getFullYear()} T-Ruby. Built with Docusaurus.`,
202+
copyright: `Copyright © ${new Date().getFullYear()} <a href="https://github.com/yhk1038" target="_blank" rel="noopener noreferrer">Fred</a> & <a href="https://github.com/type-ruby" target="_blank" rel="noopener noreferrer">T-Ruby</a>. Built with <a href="https://docusaurus.io" target="_blank" rel="noopener noreferrer">Docusaurus</a>.`,
203203
},
204204
prism: {
205205
theme: prismThemes.github,

i18n/ja/code.json

Lines changed: 87 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -212,13 +212,29 @@
212212
"description": "Hero title line 1"
213213
},
214214
"homepage.hero.titleHighlight": {
215-
"message": "TypeScriptの方法で",
216-
"description": "Hero title line 2 highlighted"
215+
"message": "型構文を持つRubyです。",
216+
"description": "Hero title highlighted text"
217217
},
218218
"homepage.hero.subtitle2": {
219-
"message": "型アノテーション付きの.trbファイルを書きましょう。ランタイムオーバーヘッドなしで標準の.rbファイルにコンパイルします",
219+
"message": "型アノテーション付きの.trbファイルを書きましょう。<br />標準の.rbファイルと.rbsにコンパイルします。<br />TypeScriptのように",
220220
"description": "Hero subtitle"
221221
},
222+
"homepage.hero.versionNotice": {
223+
"message": "T-Ruby {version} が利用可能です",
224+
"description": "Version notice with version number"
225+
},
226+
"homepage.whatIs.rubyMore.description": {
227+
"message": "T-Rubyは追加の構文でRubyを強力に拡張します。<strong>これは静的型だけでなくコンパイルタイムを意味します。</strong>",
228+
"description": "Ruby and More description"
229+
},
230+
"homepage.whatIs.trust.description": {
231+
"message": "T-RubyコードはRubyとRBSに変換されるため、<strong>Ruby、RBSが動作するすべてのエコシステムでの動作を保証します。</strong>",
232+
"description": "A Result You Can Trust description"
233+
},
234+
"homepage.whatIs.scale.description": {
235+
"message": "T-Rubyを通じてRubyで作成された製品の型安全性を確保しましょう。<strong>大規模でも安全な状態を維持できます。</strong>",
236+
"description": "Safety at Scale description"
237+
},
222238
"homepage.install.command": {
223239
"message": "gem install t-ruby",
224240
"description": "Install command"
@@ -264,7 +280,7 @@
264280
"description": "Feature description"
265281
},
266282
"homepage.codeShowcase.title": {
267-
"message": "実際の動作を見る",
283+
"message": "",
268284
"description": "Code showcase title"
269285
},
270286
"homepage.codeShowcase.subtitle": {
@@ -292,15 +308,15 @@
292308
"description": "Quick start title"
293309
},
294310
"homepage.quickStart.step1.title": {
295-
"message": "T-Rubyをインストール",
311+
"message": "プロジェクトを初期化",
296312
"description": "Step 1 title"
297313
},
298314
"homepage.quickStart.step2.title": {
299-
"message": ".trbファイルを作成",
315+
"message": "ウォッチモードを開始",
300316
"description": "Step 2 title"
301317
},
302318
"homepage.quickStart.step3.title": {
303-
"message": "コンパイルして実行",
319+
"message": "型付きRubyを書く",
304320
"description": "Step 3 title"
305321
},
306322
"homepage.quickStart.cta": {
@@ -323,6 +339,10 @@
323339
"message": "VS Code拡張機能",
324340
"description": "VS Code extension"
325341
},
342+
"homepage.tooling.editors.jetbrains": {
343+
"message": "JetBrainsプラグイン",
344+
"description": "JetBrains plugin"
345+
},
326346
"homepage.tooling.editors.neovim": {
327347
"message": "Neovimプラグイン",
328348
"description": "Neovim plugin"
@@ -363,6 +383,66 @@
363383
"message": "すべてのgemが動作",
364384
"description": "All gems work"
365385
},
386+
"homepage.existingMethods.title": {
387+
"message": "既存の方法",
388+
"description": "Existing methods section title"
389+
},
390+
"homepage.existingMethods.subtitle": {
391+
"message": "既存のRuby型付けソリューションと比較して、T-Rubyの違いを確認してください。",
392+
"description": "Existing methods section subtitle"
393+
},
394+
"homepage.existingMethods.howToUse": {
395+
"message": "使い方",
396+
"description": "How to use label"
397+
},
398+
"homepage.existingMethods.limitations": {
399+
"message": "制限事項",
400+
"description": "Limitations label"
401+
},
402+
"homepage.existingMethods.vsTRuby": {
403+
"message": "T-Rubyのアプローチ",
404+
"description": "T-Ruby approach label"
405+
},
406+
"homepage.contribute.title": {
407+
"message": "一緒に作りましょう",
408+
"description": "Contribute section title"
409+
},
410+
"homepage.contribute.subtitle": {
411+
"message": "T-Rubyはオープンソースプロジェクトです。あなたの参加が大きな力になります。",
412+
"description": "Contribute section subtitle"
413+
},
414+
"homepage.contribute.experimental": {
415+
"message": "まだ実験段階です。コアコンパイラは動作しますが、改善すべき点がたくさんあります。",
416+
"description": "Experimental stage notice"
417+
},
418+
"homepage.contribute.feedback": {
419+
"message": "フィードバックや提案はいつでも歓迎します!",
420+
"description": "Feedback welcome notice"
421+
},
422+
"homepage.contribute.star.title": {
423+
"message": "GitHubでStarする",
424+
"description": "Star card title"
425+
},
426+
"homepage.contribute.star.description": {
427+
"message": "応援してくださり、より多くの方がT-Rubyを見つけられるようにしてください",
428+
"description": "Star card description"
429+
},
430+
"homepage.contribute.issue.title": {
431+
"message": "Issue報告",
432+
"description": "Issue card title"
433+
},
434+
"homepage.contribute.issue.description": {
435+
"message": "バグを発見しましたか?新機能を提案したいですか?お知らせください",
436+
"description": "Issue card description"
437+
},
438+
"homepage.contribute.pr.title": {
439+
"message": "コード貢献",
440+
"description": "PR card title"
441+
},
442+
"homepage.contribute.pr.description": {
443+
"message": "プルリクエストを送って、型安全なRubyの未来を一緒に作りましょう",
444+
"description": "PR card description"
445+
},
366446
"homepage.layout.title": {
367447
"message": "型安全なRuby",
368448
"description": "Layout title"

i18n/ja/docusaurus-plugin-content-docs/current/getting-started/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,5 +153,5 @@ sudo dnf groupinstall "Development Tools"
153153
T-Rubyがインストールされたので、コードを書いてみましょう:
154154

155155
- [クイックスタート](/docs/getting-started/quick-start) - 5分で始める
156-
- [最初の.trbファイル](/docs/getting-started/first-trb-file) - 詳細なガイド
156+
- [.trbファイルを理解する](/docs/getting-started/understanding-trb-files) - 詳細なガイド
157157
- [エディタ設定](/docs/getting-started/editor-setup) - IDEの設定

i18n/ja/docusaurus-plugin-content-docs/current/getting-started/quick-start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,6 @@ end
149149

150150
おめでとうございます!T-Rubyの基本を学びました。さらに詳しく学ぶには:
151151

152-
- [最初の.trbファイル](/docs/getting-started/first-trb-file) - 詳細な最初のファイルガイド
152+
- [.trbファイルを理解する](/docs/getting-started/understanding-trb-files) - 詳細な最初のファイルガイド
153153
- [エディタ設定](/docs/getting-started/editor-setup) - VS Codeなどのエディタ設定
154154
- [基本構文](/docs/learn/basics/type-annotations) - T-Ruby構文を詳しく学ぶ

i18n/ja/docusaurus-plugin-content-docs/current/getting-started/first-trb-file.md renamed to i18n/ja/docusaurus-plugin-content-docs/current/getting-started/understanding-trb-files.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
sidebar_position: 3
3-
title: 最初の.trbファイル
4-
description: 最初のT-Rubyファイルの作成とコンパイル
3+
title: .trbファイルを理解する
4+
description: T-Rubyファイルの仕組みを学ぶ
55
---
66

77
<DocsBadge />
88

99

10-
# 最初の.trbファイル
10+
# .trbファイルを理解する
1111

1212
このガイドでは、T-Rubyファイルをステップバイステップで作成しながら、各概念を説明します。
1313

i18n/ko/code.json

Lines changed: 87 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -212,13 +212,29 @@
212212
"description": "Hero title line 1"
213213
},
214214
"homepage.hero.titleHighlight": {
215-
"message": "TypeScript 방식으로",
216-
"description": "Hero title line 2 highlighted"
215+
"message": "타입 문법을 갖춘 Ruby입니다.",
216+
"description": "Hero title highlighted text"
217217
},
218218
"homepage.hero.subtitle2": {
219-
"message": "타입 어노테이션이 있는 .trb 파일을 작성하세요. 런타임 오버헤드 없이 표준 .rb 파일로 컴파일됩니다.",
219+
"message": "타입 어노테이션이 있는 .trb 파일을 작성하세요.<br />표준 .rb 파일과 .rbs로 컴파일됩니다.<br />타입스크립트처럼요.",
220220
"description": "Hero subtitle"
221221
},
222+
"homepage.hero.versionNotice": {
223+
"message": "T-Ruby {version} 현재 사용 가능합니다",
224+
"description": "Version notice with version number"
225+
},
226+
"homepage.whatIs.rubyMore.description": {
227+
"message": "T-Ruby는 Ruby에 추가적인 문법을 더해 강력하게 확장합니다. <strong>이는 정적 타입뿐 아니라 컴파일 타임을 의미합니다.</strong>",
228+
"description": "Ruby and More description"
229+
},
230+
"homepage.whatIs.trust.description": {
231+
"message": "T-Ruby 코드는 Ruby와 RBS로 변환되므로, <strong>Ruby, RBS가 동작하는 모든 생태계에서의 동작을 보장합니다.</strong>",
232+
"description": "A Result You Can Trust description"
233+
},
234+
"homepage.whatIs.scale.description": {
235+
"message": "T-Ruby를 통해 Ruby로 작성된 제품의 타입 안정성을 확보하세요. <strong>큰 규모에서도 안전한 상태를 유지할 수 있습니다.</strong>",
236+
"description": "Safety at Scale description"
237+
},
222238
"homepage.install.command": {
223239
"message": "gem install t-ruby",
224240
"description": "Install command"
@@ -264,7 +280,7 @@
264280
"description": "Feature description"
265281
},
266282
"homepage.codeShowcase.title": {
267-
"message": "실제 동작 보기",
283+
"message": "예시",
268284
"description": "Code showcase title"
269285
},
270286
"homepage.codeShowcase.subtitle": {
@@ -292,15 +308,15 @@
292308
"description": "Quick start title"
293309
},
294310
"homepage.quickStart.step1.title": {
295-
"message": "T-Ruby 설치",
311+
"message": "프로젝트 초기화",
296312
"description": "Step 1 title"
297313
},
298314
"homepage.quickStart.step2.title": {
299-
"message": ".trb 파일 생성",
315+
"message": "감시 모드 시작",
300316
"description": "Step 2 title"
301317
},
302318
"homepage.quickStart.step3.title": {
303-
"message": "컴파일 및 실행",
319+
"message": "타입이 있는 Ruby 작성",
304320
"description": "Step 3 title"
305321
},
306322
"homepage.quickStart.cta": {
@@ -323,6 +339,10 @@
323339
"message": "VS Code 확장",
324340
"description": "VS Code extension"
325341
},
342+
"homepage.tooling.editors.jetbrains": {
343+
"message": "JetBrains 플러그인",
344+
"description": "JetBrains plugin"
345+
},
326346
"homepage.tooling.editors.neovim": {
327347
"message": "Neovim 플러그인",
328348
"description": "Neovim plugin"
@@ -363,6 +383,66 @@
363383
"message": "모든 gem 작동",
364384
"description": "All gems work"
365385
},
386+
"homepage.existingMethods.title": {
387+
"message": "기존 방법들",
388+
"description": "Existing methods section title"
389+
},
390+
"homepage.existingMethods.subtitle": {
391+
"message": "기존 Ruby 타이핑 솔루션과 비교하고, T-Ruby가 어떻게 다른지 확인하세요.",
392+
"description": "Existing methods section subtitle"
393+
},
394+
"homepage.existingMethods.howToUse": {
395+
"message": "사용 방법",
396+
"description": "How to use label"
397+
},
398+
"homepage.existingMethods.limitations": {
399+
"message": "한계점",
400+
"description": "Limitations label"
401+
},
402+
"homepage.existingMethods.vsTRuby": {
403+
"message": "T-Ruby의 접근 방식",
404+
"description": "T-Ruby approach label"
405+
},
406+
"homepage.contribute.title": {
407+
"message": "함께 만들어가요",
408+
"description": "Contribute section title"
409+
},
410+
"homepage.contribute.subtitle": {
411+
"message": "T-Ruby는 오픈소스 프로젝트입니다. 여러분의 참여가 큰 힘이 됩니다.",
412+
"description": "Contribute section subtitle"
413+
},
414+
"homepage.contribute.experimental": {
415+
"message": "아직 실험 단계입니다. 핵심 컴파일러는 작동하지만, 개선할 부분이 많습니다.",
416+
"description": "Experimental stage notice"
417+
},
418+
"homepage.contribute.feedback": {
419+
"message": "피드백과 제안은 언제든 환영합니다!",
420+
"description": "Feedback welcome notice"
421+
},
422+
"homepage.contribute.star.title": {
423+
"message": "GitHub에서 Star 주기",
424+
"description": "Star card title"
425+
},
426+
"homepage.contribute.star.description": {
427+
"message": "응원을 보내주시고 더 많은 분들이 T-Ruby를 발견할 수 있도록 도와주세요",
428+
"description": "Star card description"
429+
},
430+
"homepage.contribute.issue.title": {
431+
"message": "이슈 제보하기",
432+
"description": "Issue card title"
433+
},
434+
"homepage.contribute.issue.description": {
435+
"message": "버그를 발견하셨거나 새로운 기능을 제안하고 싶으신가요? 알려주세요",
436+
"description": "Issue card description"
437+
},
438+
"homepage.contribute.pr.title": {
439+
"message": "코드 기여하기",
440+
"description": "PR card title"
441+
},
442+
"homepage.contribute.pr.description": {
443+
"message": "Pull Request를 제출하여 타입 안전한 Ruby의 미래를 함께 만들어가세요",
444+
"description": "PR card description"
445+
},
366446
"homepage.layout.title": {
367447
"message": "타입 안전한 Ruby",
368448
"description": "Layout title"

i18n/ko/docusaurus-plugin-content-docs/current/getting-started/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,5 +153,5 @@ sudo dnf groupinstall "Development Tools"
153153
T-Ruby가 설치되었으니, 이제 코드를 작성해봅시다:
154154

155155
- [빠른 시작](/docs/getting-started/quick-start) - 5분 만에 시작하기
156-
- [첫 번째 .trb 파일](/docs/getting-started/first-trb-file) - 상세한 안내
156+
- [.trb 파일 이해하기](/docs/getting-started/understanding-trb-files) - 상세한 안내
157157
- [에디터 설정](/docs/getting-started/editor-setup) - IDE 설정

0 commit comments

Comments
 (0)