Skip to content
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

docs: add about component kinds and where should be added #327

Merged
merged 3 commits into from
Aug 19, 2023

Conversation

anatawa12
Copy link
Owner

@anatawa12 anatawa12 commented Aug 17, 2023

Closes #323

image

@anatawa12 anatawa12 added the documentation Improvements or additions to documentation label Aug 17, 2023
@anatawa12 anatawa12 marked this pull request as ready for review August 17, 2023 06:26
@Sayamame-beans
Copy link
Collaborator

これ、例えば、Avatar Global Componentsとしての2つ(Trace and Optimize, UnusedBonesByReferencesTool)、という形だと思うんですが、それが各Componentと同列に並んでいるのは違和感があります。
階層的に表示出来たりってしないですかね…?

@anatawa12
Copy link
Owner Author

ディレクトリ構造変えないと無理そうだったので諦めました。
boldにしたかったけどそれも方法がなかったため現状諦めてます。

@Sayamame-beans
Copy link
Collaborator

なるほど…
しかし、ここにあるべきでは無いという感じが個人的にとても強いです。
とはいえ、Reference以外の場所に"Avatar Global Components"などを配置?と考えてみても、適当なラベル名は思い付かず…(Components Kindとかならギリギリ?)

@anatawa12
Copy link
Owner Author

anatawa12 commented Aug 18, 2023

image こうする?

@anatawa12
Copy link
Owner Author

image

@Sayamame-beans
Copy link
Collaborator

ですです
そんな感じにすると、(後付けで入れてるので若干不自然な区分分けかもしれませんが、)分かりやすいかなぁと思いました

@anatawa12
Copy link
Owner Author

じゃぁこれで行きます

@Sayamame-beans
Copy link
Collaborator

本体のレビューにはもう少々お時間をいただきたいです(現在、満足にレビュー出来る環境にないため…)

@anatawa12
Copy link
Owner Author

@Sayamame-beans こちらも先mergeし、後で修正の形を取りたいと思います

@anatawa12 anatawa12 merged commit d16047f into master Aug 19, 2023
@anatawa12 anatawa12 deleted the improve-documentation branch August 19, 2023 18:24
@anatawa12
Copy link
Owner Author

reviewというかpullreqの形でいただけるとありがたいかも

@Sayamame-beans
Copy link
Collaborator

あ~…

@Sayamame-beans
Copy link
Collaborator

変更箇所を一覧出来ないので厳しいかも
一旦全部書いてから明日にでもPR出します

Copy link
Collaborator

@Sayamame-beans Sayamame-beans left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

レビュー終わりました。
抜けとかあるかもなのでPR書きつつ調整します。

Sayamame-beans added a commit that referenced this pull request Aug 22, 2023
Sayamame-beans added a commit that referenced this pull request Aug 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

AvatarGlobalComponentとEditSkinnedMeshComponent についてドキュメント化する
2 participants