-
Notifications
You must be signed in to change notification settings - Fork 6
各パッケージのREADMEにコンポーネントのデザインドキュメントを同梱 #101
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
nio-nio-nio
wants to merge
13
commits into
main
Choose a base branch
from
enrich-readme-with-design-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
d574b42
各パッケージのREADMEにdesign.pepabo.comのコンポーネントドキュメントを転載
bed005b
AIエージェントがデザインドキュメントに到達できる導線を追加
f219a8e
CLAUDE.md / AGENTS.md の実態と合わない参照記述を削除
c675582
snackbar README のコードフェンス外に出ていた閉じタグを修正
9dfba33
snackbar README の _trailing typo とコードフェンス崩れを修正
1f93bee
Pepper flavor表からカラーコードを削除
6e2f0c1
design-docマーカーの文言を実態に合わせる
95867db
READMEの原本記述を確認可能な公開URLに修正
dc868b0
Revert "READMEの原本記述を確認可能な公開URLに修正"
94b865d
design.pepabo.com の mdx を README へ転載する変換スクリプトを追加
a64da5b
design-docマーカーの文言を再生成コマンドを指すよう更新
147c7cb
デザインドキュメントから外部ドメインへの言及・リンクを除去
d569f48
変換スクリプトをリポジトリ外の管理に移す
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| # @pepabo-inhouse/app-bar | ||
|
|
||
| GMO ペパボのデザインシステム Inhouse の App Bar コンポーネント(SCSS)。 | ||
|
|
||
| このコンポーネントを使った UI の実装・変更を行う前に、同ディレクトリの README.md 末尾にある「デザインドキュメント (Design Documentation)」節を必ず読むこと。コンポーネントの使い分け・バリエーション・ステート・アクセシビリティ・ライティングの規約が全文記載されている(https://design.pepabo.com/inhouse/components/app-bar/ からの転載)。 | ||
|
|
||
| SCSS mixin の使い方(`style($options)` によるエイリアシング等)は README.md 冒頭の Usage 節を参照。 | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| # @pepabo-inhouse/app-bar | ||
|
|
||
| GMO ペパボのデザインシステム Inhouse の App Bar コンポーネント(SCSS)。 | ||
|
|
||
| このコンポーネントを使った UI の実装・変更を行う前に、同ディレクトリの README.md 末尾にある「デザインドキュメント (Design Documentation)」節を必ず読むこと。コンポーネントの使い分け・バリエーション・ステート・アクセシビリティ・ライティングの規約が全文記載されている(https://design.pepabo.com/inhouse/components/app-bar/ からの転載)。 | ||
|
|
||
| SCSS mixin の使い方(`style($options)` によるエイリアシング等)は README.md 冒頭の Usage 節を参照。 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| # @pepabo-inhouse/avatar | ||
|
|
||
| GMO ペパボのデザインシステム Inhouse の Avatar コンポーネント(SCSS)。 | ||
|
|
||
| このコンポーネントを使った UI の実装・変更を行う前に、同ディレクトリの README.md 末尾にある「デザインドキュメント (Design Documentation)」節を必ず読むこと。コンポーネントの使い分け・バリエーション・ステート・アクセシビリティ・ライティングの規約が全文記載されている(https://design.pepabo.com/inhouse/components/avatar/ からの転載)。 | ||
|
|
||
| SCSS mixin の使い方(`style($options)` によるエイリアシング等)は README.md 冒頭の Usage 節を参照。 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| # @pepabo-inhouse/avatar | ||
|
|
||
| GMO ペパボのデザインシステム Inhouse の Avatar コンポーネント(SCSS)。 | ||
|
|
||
| このコンポーネントを使った UI の実装・変更を行う前に、同ディレクトリの README.md 末尾にある「デザインドキュメント (Design Documentation)」節を必ず読むこと。コンポーネントの使い分け・バリエーション・ステート・アクセシビリティ・ライティングの規約が全文記載されている(https://design.pepabo.com/inhouse/components/avatar/ からの転載)。 | ||
|
|
||
| SCSS mixin の使い方(`style($options)` によるエイリアシング等)は README.md 冒頭の Usage 節を参照。 |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
全体的に、README冒頭のUsageにscss mixinベースの使い方が書かれていないので実態と違った記述になってました。この文章は無くてもいいのではないでしょうか(READMEを参照せよという旨は先の段落で示せているし)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
いや、buttonだけはUsageにmixinの使い方が書いてありました(が、これはこれで実装セクションと内容的な重複にも捉えられるのでどちらかへ集約するのが良いけれども)