Skip to content

[Docs] Fix broken markdown and incorrect info in contributing page #14

@yhk1038

Description

@yhk1038

Problem

The contributing page (https://type-ruby.github.io/docs/project/contributing) has broken markdown rendering and incorrect community information.

1. Broken Markdown

In the "Report Bugs" section, there is a nested code block example that breaks markdown rendering:

**Example:**
\`\`\`markdown
## Bug: Type inference fails for array map

**T-Ruby Version:** v0.1.0
**Ruby Version:** 3.2.0

### Steps to Reproduce
\`\`\`trb
numbers: Array<Integer> = [1, 2, 3]
...
\`\`\`

The inner code block (trb) inside the outer code block (markdown) causes rendering issues.

2. Incorrect Community Information

The following incorrect information needs to be corrected:

Current (incorrect):

Should be:

  • GitHub Issues for bug reports
  • GitHub Discussions for questions and community discussion
  • Website News for announcements
  • Remove Discord, Twitter, and email references

Files to update

  • docs/project/contributing.md

Required changes

  1. Fix the nested code block in "Report Bugs" example section
  2. Update "Where to Ask Questions" section:
    • Keep GitHub Discussions and GitHub Issues
    • Remove Discord reference
    • Remove Stack Overflow reference (optional)
  3. Update "Contact" section:
    • Remove Twitter
    • Remove Discord
    • Remove or update email

Metadata

Metadata

Assignees

Labels

bugSomething isn't working

Type

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions