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 improvements #961

Merged
merged 33 commits into from
Apr 1, 2024
Merged

Docs improvements #961

merged 33 commits into from
Apr 1, 2024

Conversation

anatawa12
Copy link
Owner

@anatawa12 anatawa12 commented Mar 27, 2024

Fixes #544
Fixes #891
Fixes #655
Fixes #765
Fixes #537
Fixes #814
Fixes #947

TODOs after applying suggestions

@anatawa12 anatawa12 added the documentation Improvements or additions to documentation label Mar 27, 2024
@anatawa12 anatawa12 marked this pull request as ready for review March 27, 2024 18:12
@Sayamame-beans
Copy link
Collaborator

d7e035b は別のレビュー中に気付いて気になったので直しました
が…Optimize Animatorが何をどうするのか全く情報ないですね…?

@anatawa12
Copy link
Owner Author

Animator Optimizer、何するというのが結構説明が重いのでどこで説明しようってことになる

@Sayamame-beans
Copy link
Collaborator

Sayamame-beans commented Mar 28, 2024

量が多いなら##とかで節を生やして、そっちに詳細説明を委ねる感じが良さそうな気がしますね

ページ分けも考えてみましたが、現段階ではややこしくなるだけかも

@anatawa12
Copy link
Owner Author

節分けるか

@anatawa12
Copy link
Owner Author

ready for reviewのつもりです (reviewされてないので再requestはできない状態になってる)

@Sayamame-beans
Copy link
Collaborator

ready for reviewのつもりです (reviewされてないので再requestはできない状態になってる)

絶賛レビュー中です

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.

部分レビュー

.docs/content/docs/basic-consept/index.ja.md Outdated Show resolved Hide resolved
.docs/content/docs/basic-consept/index.ja.md Outdated Show resolved Hide resolved
.docs/content/docs/tutorial/basic-usage/index.ja.md Outdated Show resolved Hide resolved
.docs/content/docs/tutorial/basic-usage/index.md Outdated Show resolved Hide resolved
@Sayamame-beans
Copy link
Collaborator

review request: d2a1215

@anatawa12
Copy link
Owner Author

faqのmaterial slot animationの話書きました

@Sayamame-beans
Copy link
Collaborator

Sayamame-beans commented Mar 31, 2024

細かな改行周りはapplyされてリリースされてから確認して直すかも
(揃ってなかったり、間が空きすぎそうだったりしているけど)

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.

github sponsors とか boothとか、[]で囲ってあるやつのcapitalize確認してなかったなぁとなっています…どうしよう

.docs/content/docs/faq/index.ja.md Outdated Show resolved Hide resolved
.docs/content/docs/faq/index.md Outdated Show resolved Hide resolved
.docs/content/docs/faq/index.md Outdated Show resolved Hide resolved
.docs/content/docs/faq/index.ja.md Outdated Show resolved Hide resolved
.docs/content/docs/faq/index.ja.md Outdated Show resolved Hide resolved
.docs/content/docs/faq/index.ja.md Outdated Show resolved Hide resolved
@Sayamame-beans
Copy link
Collaborator

同じキーが2つ…? (en未確認)

msgid "MakeChildren:tooltip:executeEarly"
msgstr "早期に実行する"
msgid "MakeChildren:tooltip:executeEarly"
msgstr "MakeChildrenをModular Avatarのような多くの他ツールより先に実行する。"

.docs/content/docs/basic-consept/index.ja.md Outdated Show resolved Hide resolved
.docs/content/docs/basic-consept/index.ja.md Outdated Show resolved Hide resolved
.docs/content/docs/basic-consept/index.ja.md Outdated Show resolved Hide resolved
.docs/content/docs/basic-consept/index.ja.md Outdated Show resolved Hide resolved
.docs/content/docs/basic-consept/index.ja.md Outdated Show resolved Hide resolved
.docs/content/docs/basic-consept/index.ja.md Outdated Show resolved Hide resolved
.docs/content/docs/basic-consept/index.ja.md Outdated Show resolved Hide resolved
.docs/content/docs/basic-consept/index.ja.md Outdated Show resolved Hide resolved
.docs/content/docs/basic-consept/index.ja.md Outdated Show resolved Hide resolved
.docs/content/docs/faq/index.ja.md Show resolved Hide resolved
@Sayamame-beans
Copy link
Collaborator

(#961 (comment) はanatawaさんにどうなってるか聞かないと分かんないです…)

@anatawa12
Copy link
Owner Author

同じキーが2つ…? (en未確認)

msgid "MakeChildren:tooltip:executeEarly"
msgstr "早期に実行する"
msgid "MakeChildren:tooltip:executeEarly"
msgstr "MakeChildrenをModular Avatarのような多くの他ツールより先に実行する。"

:prop:であるところが:tooltip:二なんかの手違いでなっていそう

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.

re-review

.docs/content/docs/faq/index.md Outdated Show resolved Hide resolved
.docs/content/docs/faq/index.md Outdated Show resolved Hide resolved
.docs/content/docs/faq/index.md Outdated Show resolved Hide resolved
.docs/content/docs/faq/index.md Outdated Show resolved Hide resolved
.docs/content/docs/faq/index.md Outdated Show resolved Hide resolved
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.

might be last review?

.docs/content/docs/basic-consept/index.md Outdated Show resolved Hide resolved
.docs/content/docs/basic-consept/index.md Outdated Show resolved Hide resolved
.docs/content/docs/basic-consept/index.md Outdated Show resolved Hide resolved
.docs/content/docs/basic-consept/index.md Outdated Show resolved Hide resolved
.docs/content/docs/basic-consept/index.md Outdated Show resolved Hide resolved
.docs/content/docs/basic-consept/index.md Outdated Show resolved Hide resolved
.docs/content/docs/basic-consept/index.md Outdated Show resolved Hide resolved
.docs/content/docs/basic-consept/index.md Outdated Show resolved Hide resolved
.docs/content/docs/basic-consept/index.md Outdated Show resolved Hide resolved
.docs/content/docs/basic-consept/index.md Outdated Show resolved Hide resolved
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.

this should be the last review

.docs/content/docs/basic-consept/index.md Outdated Show resolved Hide resolved
.docs/content/docs/basic-consept/index.md Outdated Show resolved Hide resolved
.docs/content/docs/basic-consept/index.md Outdated Show resolved Hide resolved
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.

final last review?

.docs/content/docs/basic-concept/index.ja.md Outdated Show resolved Hide resolved
.docs/content/docs/basic-concept/index.ja.md Outdated Show resolved Hide resolved
.docs/content/docs/basic-concept/index.ja.md Outdated Show resolved Hide resolved
.docs/content/docs/basic-concept/index.md Outdated Show resolved Hide resolved

In some bugs, fixing them may change the behavior of the component widely.\
To fix such bugs, we usually add new flag to enable the new behavior.\
By making the flag disabled by default for existing components, we keep the behavior of the existing components and by making the flag enabled by default for newly added components, we fix the bug for new components.
Copy link
Collaborator

Choose a reason for hiding this comment

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

上でalready added componentになってたけど、揃える?

Copy link
Collaborator

Choose a reason for hiding this comment

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

for new components →newly added components?

Copy link
Owner Author

Choose a reason for hiding this comment

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

両方揃えたほうが良さそうかな

Copy link
Owner Author

Choose a reason for hiding this comment

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

Suggested change
By making the flag disabled by default for existing components, we keep the behavior of the existing components and by making the flag enabled by default for newly added components, we fix the bug for new components.
By making the flag disabled by default for already added components, we keep the behavior of the existing components and by making the flag enabled by default for newly added components, we fix the bug for newly added components.

Copy link
Collaborator

Choose a reason for hiding this comment

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

であれば、

Suggested change
By making the flag disabled by default for existing components, we keep the behavior of the existing components and by making the flag enabled by default for newly added components, we fix the bug for new components.
By making the flag disabled by default for already added components, we keep the behavior of already added components and by making the flag enabled by default for newly added components, we fix the bug for newly added components.

.docs/content/docs/faq/index.md Outdated Show resolved Hide resolved
.docs/content/docs/faq/index.md Outdated Show resolved Hide resolved
@anatawa12 anatawa12 requested a review from Sayamame-beans April 1, 2024 04:46
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.

LGTM!

@anatawa12 anatawa12 merged commit 0490e40 into master Apr 1, 2024
8 checks passed
@anatawa12 anatawa12 deleted the docs-improvements branch April 1, 2024 06:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment