Skip to content

Commit b711171

Browse files
yhk1038yhk1038
committed
docs: fix incorrect community info and broken markdown
- Remove Discord and Twitter references - Replace with GitHub Discussions and News section - Fix nested code block rendering issue in contributing page - Update GitHub URLs to type-ruby organization Closes #13, closes #14
1 parent 2908890 commit b711171

6 files changed

Lines changed: 33 additions & 50 deletions

File tree

‎docs/project/changelog.md‎

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -347,10 +347,8 @@ We're already working on v0.2.0 with:
347347

348348
This is an experimental release. We'd love your feedback!
349349

350-
- Report bugs on [GitHub Issues](https://github.com/t-ruby/t-ruby/issues)
351-
- Suggest features in [GitHub Discussions](https://github.com/t-ruby/t-ruby/discussions)
352-
- Join our [Discord community](https://discord.gg/t-ruby)
353-
- Follow [@t_ruby](https://twitter.com/t_ruby) for updates
350+
- Report bugs on [GitHub Issues](https://github.com/type-ruby/t-ruby/issues)
351+
- Suggest features in [GitHub Discussions](https://github.com/type-ruby/t-ruby/discussions)
354352

355353
#### Contributors
356354

@@ -439,15 +437,14 @@ Bleeding edge builds from `main` branch (not recommended).
439437

440438
## Stay Updated
441439

442-
- Watch the [GitHub repository](https://github.com/t-ruby/t-ruby) for releases
443-
- Follow [@t_ruby](https://twitter.com/t_ruby) for announcements
444-
- Join [Discord](https://discord.gg/t-ruby) for discussions
445-
- Subscribe to the newsletter (coming soon)
440+
- Watch the [GitHub repository](https://github.com/type-ruby/t-ruby) for releases
441+
- Check the [News section](https://type-ruby.github.io/news) for announcements
442+
- Join [GitHub Discussions](https://github.com/type-ruby/t-ruby/discussions) for discussions
446443

447444
## Archive
448445

449446
All releases are available on:
450-
- [GitHub Releases](https://github.com/t-ruby/t-ruby/releases)
447+
- [GitHub Releases](https://github.com/type-ruby/t-ruby/releases)
451448
- [RubyGems.org](https://rubygems.org/gems/t-ruby)
452449

453450
---

‎docs/project/contributing.md‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@ Found a bug? Please open an issue on GitHub with:
3939
- **Error messages** - Full error output if applicable
4040

4141
**Example:**
42-
```markdown
42+
43+
````markdown
4344
## Bug: Type inference fails for array map
4445

4546
**T-Ruby Version:** v0.1.0
@@ -57,7 +58,7 @@ strings = numbers.map { |n| n.to_s }
5758

5859
### Actual
5960
Type is inferred as `Any[]`
60-
```
61+
````
6162

6263
### 2. Suggest Features
6364

@@ -564,8 +565,6 @@ We follow [Semantic Versioning](https://semver.org/):
564565

565566
- **GitHub Discussions** - General questions, ideas
566567
- **GitHub Issues** - Bug reports, feature requests
567-
- **Discord** - Real-time chat with community
568-
- **Stack Overflow** - Tag questions with `t-ruby`
569568

570569
### Good Questions Include
571570

@@ -589,17 +588,16 @@ By contributing to T-Ruby, you agree that your contributions will be licensed un
589588

590589
## Resources
591590

592-
- **GitHub Repository** - https://github.com/t-ruby/t-ruby
593-
- **Documentation** - https://t-ruby.github.io
591+
- **GitHub Repository** - https://github.com/type-ruby/t-ruby
592+
- **Documentation** - https://type-ruby.github.io
594593
- **Style Guide** - https://rubystyle.guide/
595594
- **RSpec Guide** - https://rspec.info/
596595
- **Semantic Versioning** - https://semver.org/
597596

598597
## Contact
599598

600-
- **Email** - maintainers@t-ruby.org
601-
- **Twitter** - @t_ruby
602-
- **Discord** - [Join our server](https://discord.gg/t-ruby)
599+
- **GitHub** - https://github.com/type-ruby/t-ruby
600+
- **Discussions** - https://github.com/type-ruby/t-ruby/discussions
603601

604602
---
605603

‎i18n/ja/docusaurus-plugin-content-docs/current/project/changelog.md‎

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -284,10 +284,8 @@ v0.2.0に向けて作業中：
284284

285285
これは実験的なリリースです。フィードバックをお待ちしています！
286286

287-
- [GitHub Issues](https://github.com/t-ruby/t-ruby/issues)でバグを報告
288-
- [GitHub Discussions](https://github.com/t-ruby/t-ruby/discussions)で機能を提案
289-
- [Discordコミュニティ](https://discord.gg/t-ruby)に参加
290-
- 更新のために[@t_ruby](https://twitter.com/t_ruby)をフォロー
287+
- [GitHub Issues](https://github.com/type-ruby/t-ruby/issues)でバグを報告
288+
- [GitHub Discussions](https://github.com/type-ruby/t-ruby/discussions)で機能を提案
291289

292290
#### コントリビューター
293291

@@ -372,15 +370,14 @@ T-Rubyは[セマンティックバージョニング](https://semver.org/)に従
372370

373371
## 最新情報を入手
374372

375-
- [GitHubリポジトリ](https://github.com/t-ruby/t-ruby)でリリースをウォッチ
376-
- お知らせのために[@t_ruby](https://twitter.com/t_ruby)をフォロー
377-
- ディスカッションのために[Discord](https://discord.gg/t-ruby)に参加
378-
- ニュースレターを購読（近日公開）
373+
- [GitHubリポジトリ](https://github.com/type-ruby/t-ruby)でリリースをウォッチ
374+
- お知らせのために[ニュースセクション](https://type-ruby.github.io/news)をチェック
375+
- ディスカッションのために[GitHub Discussions](https://github.com/type-ruby/t-ruby/discussions)に参加
379376

380377
## アーカイブ
381378

382379
すべてのリリースは以下で利用可能：
383-
- [GitHub Releases](https://github.com/t-ruby/t-ruby/releases)
380+
- [GitHub Releases](https://github.com/type-ruby/t-ruby/releases)
384381
- [RubyGems.org](https://rubygems.org/gems/t-ruby)
385382

386383
---

‎i18n/ja/docusaurus-plugin-content-docs/current/project/contributing.md‎

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -564,8 +564,6 @@ PRをレビューする際：
564564

565565
- **GitHub Discussions** - 一般的な質問、アイデア
566566
- **GitHub Issues** - バグ報告、機能リクエスト
567-
- **Discord** - コミュニティとのリアルタイムチャット
568-
- **Stack Overflow** - `t-ruby`タグで質問
569567

570568
### 良い質問に含めるもの
571569

@@ -589,17 +587,16 @@ T-Rubyに貢献することで、あなたの貢献がMITライセンスの下
589587

590588
## リソース
591589

592-
- **GitHubリポジトリ** - https://github.com/t-ruby/t-ruby
593-
- **ドキュメント** - https://t-ruby.github.io
590+
- **GitHubリポジトリ** - https://github.com/type-ruby/t-ruby
591+
- **ドキュメント** - https://type-ruby.github.io
594592
- **スタイルガイド** - https://rubystyle.guide/
595593
- **RSpecガイド** - https://rspec.info/
596594
- **セマンティックバージョニング** - https://semver.org/
597595

598596
## 連絡先
599597

600-
- **メール** - maintainers@t-ruby.org
601-
- **Twitter** - @t_ruby
602-
- **Discord** - [サーバーに参加](https://discord.gg/t-ruby)
598+
- **GitHub** - https://github.com/type-ruby/t-ruby
599+
- **Discussions** - https://github.com/type-ruby/t-ruby/discussions
603600

604601
---
605602

‎i18n/ko/docusaurus-plugin-content-docs/current/project/changelog.md‎

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -286,10 +286,8 @@ end
286286

287287
이것은 실험적 릴리스입니다. 여러분의 피드백을 기다립니다!
288288

289-
- [GitHub Issues](https://github.com/t-ruby/t-ruby/issues)에서 버그 보고
290-
- [GitHub Discussions](https://github.com/t-ruby/t-ruby/discussions)에서 기능 제안
291-
- [Discord 커뮤니티](https://discord.gg/t-ruby) 참여
292-
- 업데이트를 위해 [@t_ruby](https://twitter.com/t_ruby) 팔로우
289+
- [GitHub Issues](https://github.com/type-ruby/t-ruby/issues)에서 버그 보고
290+
- [GitHub Discussions](https://github.com/type-ruby/t-ruby/discussions)에서 기능 제안
293291

294292
#### 기여자
295293

@@ -374,15 +372,14 @@ T-Ruby는 [시맨틱 버저닝](https://semver.org/)을 따릅니다:
374372

375373
## 최신 정보 얻기
376374

377-
- [GitHub 저장소](https://github.com/t-ruby/t-ruby)에서 릴리스 주시
378-
- 발표를 위해 [@t_ruby](https://twitter.com/t_ruby) 팔로우
379-
- 토론을 위해 [Discord](https://discord.gg/t-ruby) 참여
380-
- 뉴스레터 구독 (출시 예정)
375+
- [GitHub 저장소](https://github.com/type-ruby/t-ruby)에서 릴리스 주시
376+
- 발표를 위해 [뉴스 섹션](https://type-ruby.github.io/news) 확인
377+
- 토론을 위해 [GitHub Discussions](https://github.com/type-ruby/t-ruby/discussions) 참여
381378

382379
## 아카이브
383380

384381
모든 릴리스는 다음에서 사용 가능합니다:
385-
- [GitHub Releases](https://github.com/t-ruby/t-ruby/releases)
382+
- [GitHub Releases](https://github.com/type-ruby/t-ruby/releases)
386383
- [RubyGems.org](https://rubygems.org/gems/t-ruby)
387384

388385
---

‎i18n/ko/docusaurus-plugin-content-docs/current/project/contributing.md‎

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -580,8 +580,6 @@ PR 리뷰 시:
580580

581581
- **GitHub Discussions** - 일반적인 질문, 아이디어
582582
- **GitHub Issues** - 버그 보고, 기능 요청
583-
- **Discord** - 커뮤니티와 실시간 채팅
584-
- **Stack Overflow** - `t-ruby` 태그로 질문
585583

586584
### 좋은 질문에 포함할 것
587585

@@ -605,17 +603,16 @@ T-Ruby에 기여함으로써, 귀하의 기여가 MIT 라이선스에 따라 라
605603

606604
## 리소스
607605

608-
- **GitHub 저장소** - https://github.com/t-ruby/t-ruby
609-
- **문서** - https://t-ruby.github.io
606+
- **GitHub 저장소** - https://github.com/type-ruby/t-ruby
607+
- **문서** - https://type-ruby.github.io
610608
- **스타일 가이드** - https://rubystyle.guide/
611609
- **RSpec 가이드** - https://rspec.info/
612610
- **시맨틱 버저닝** - https://semver.org/
613611

614612
## 연락처
615613

616-
- **이메일** - maintainers@t-ruby.org
617-
- **Twitter** - @t_ruby
618-
- **Discord** - [서버 참가](https://discord.gg/t-ruby)
614+
- **GitHub** - https://github.com/type-ruby/t-ruby
615+
- **Discussions** - https://github.com/type-ruby/t-ruby/discussions
619616

620617
---
621618

0 commit comments

Comments
 (0)