TWE Design System: Create Microsite Documentation Standards and Contributor Guidelines
オープン
@revforyou がすでに取り組んでいます。
2026年6月16日 から。
評価
この issue はまだ評価されていません。
説明
complexity: small
feature: design system
role: engineering
size: 1pt
Overview
As more Design System microsites are added and updated, there is currently no documented standard for page structure, content organization, or implementation patterns.
Action Items
- Recommended microsite page structure and section order
- Expected documentation sections (Overview, Specs, Usage, Accessibility, Code, Examples, etc.)
- Guidelines for code examples and previews
- File organization and where component assets should live
- SCSS and styling conventions
- Relationship between Figma designs and implementation
- Include necessary files in the MKdocs docs/ folder and project config
- Best practices for maintaining consistency across microsites
Resources
- 1.01 Design Reference
- 1.02 WIKI: Design system microsite JavaScript
- 1.03 MKdocs folder: /docs on repo
- 1.04 MDdocs config file: mkdocs.yml on repo
- 1.05 variables file: /docs/components/sass/abstracts/_variables.scss on repo
- 1.06 SASS file folder: /docs/components/sass/components
- 1.07 Variables SASS Sheet: /docs/components/sass/abstracts/variables.sss
- 主要言語
- CSS
- スター
- 20
- フォーク
- 6
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
hackforla/internship のほかの issue
-
documentation help wanted question
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
hackforla/internship#835 ·
-
TWE: Research: Skills Issue: Onboard and Assess: Promise McEntire再び着手できるかも @promise-mc が 30 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンfeature: onboarding feature: skills assessment good first issue Participant Type: TWE Team Member role: new team member role: UI/UX research size: 0.50pt
hackforla/internship#833 · コメント 28 件 · 担当者 1 名 ·
-
TWE: Dev: Design System: Update Toggle with Tokens再び着手できるかも @zvidmarb が 143 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンcomplexity: small feature: design system Participant Type: TWE Team Member role: engineering size: 1pt
hackforla/internship#830 · 担当者 1 名 ·
-
complexity: medium feature: design system Participant Type: TWE Team Member role: engineering size: 2pt
難易度 4/5 3〜5日 初心者へのやさしさ 52/100
hackforla/internship#829 ·
-
complexity: medium feature: design system Participant Type: TWE Team Member role: engineering size: 2pt
難易度 4/5 3〜5日 初心者へのやさしさ 55/100
hackforla/internship#828 ·