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.

Sign up for GitHub

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

Jump to bottom

Add explanation for Component and ComponentContents #4

Merged
merged 17 commits into from
Aug 4, 2023
Merged

Add explanation for Component and ComponentContents #4

merged 17 commits into from
Aug 4, 2023

Conversation

tmvkrpxl0
Copy link
Contributor

@tmvkrpxl0 tmvkrpxl0 commented Jul 23, 2023 •
edited by neoforged-pages-deployments bot
Loading

Internalization document only just mentions Component and ComponentContents without proper explanation. Although I don't fully understand these two, I've decided to come up with my own section for it.

Preview URL: https://pr-4.neoforged-docs-previews.pages.dev

ChampionAsh5357
ChampionAsh5357 requested changes Jul 24, 2023
View reviewed changes
Copy link
Contributor

@ChampionAsh5357 ChampionAsh5357 left a comment

Choose a reason for hiding this comment

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

Excluding grammar, this needs more information on the types of components along with associated examples. It also makes more sense for components to be a separate page as the only contents that deals with localization is TranslatableContents.

docs/concepts/internationalization.md Outdated Show resolved Hide resolved
docs/concepts/internationalization.md Outdated Show resolved Hide resolved
docs/concepts/internationalization.md Outdated Show resolved Hide resolved
docs/concepts/internationalization.md Show resolved Hide resolved
docs/concepts/internationalization.md Outdated Show resolved Hide resolved
@tmvkrpxl0
Copy link
Contributor Author

Sorry for multiple force push, I tried to turn my last commit as verified, but it doesn't seem to work.
I have made Components page into separate one and moved into different directory.
This time there would be less grammar error, I double checked with external tools.

ChampionAsh5357
ChampionAsh5357 requested changes Jul 27, 2023
View reviewed changes
Copy link
Contributor

@ChampionAsh5357 ChampionAsh5357 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 also talk about why most users should only use translatable contents to support localization in other languages.

docs/concepts/internationalization.md Outdated Show resolved Hide resolved
docs/misc/components.md Outdated Show resolved Hide resolved
docs/misc/components.md Outdated Show resolved Hide resolved
docs/misc/components.md Outdated Show resolved Hide resolved
docs/misc/components.md Outdated Show resolved Hide resolved
docs/misc/components.md Outdated Show resolved Hide resolved
docs/misc/components.md Outdated Show resolved Hide resolved
docs/misc/components.md Outdated Show resolved Hide resolved
docs/misc/components.md Outdated Show resolved Hide resolved
docs/misc/components.md Outdated Show resolved Hide resolved
@tmvkrpxl0 @ChampionAsh5357
Apply suggestions from code review
11130ce 
Co-authored-by: ChampionAsh5357 <championash5357@gmail.com>
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) July 28, 2023 18:57 Active
@neoforged-pages-deployments
Copy link

neoforged-pages-deployments bot commented Jul 28, 2023 •
edited
Loading

Deploying with Cloudflare Pages

Name Result
Last commit: 0332500a24c37e1b2f6999e1369724a77398f3a8
Status: ✅ Deploy successful!
Preview URL: https://92d7e5e5.neoforged-docs-previews.pages.dev
PR Preview URL: https://pr-4.neoforged-docs-previews.pages.dev

@tmvkrpxl0
Copy link
Contributor Author

w h a t
There's auto deploy for PRs too? Wow

@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) July 29, 2023 10:43 Active
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) July 29, 2023 10:44 Active
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) July 29, 2023 12:11 Active
ChampionAsh5357
ChampionAsh5357 requested changes Jul 29, 2023
View reviewed changes
Copy link
Contributor

@ChampionAsh5357 ChampionAsh5357 left a comment

Choose a reason for hiding this comment

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

Lot of missing articles.

Additionally, we should be using text wrapping for lines, so paragraphs should be on a single line, not spread across multiple.

docs/concepts/internationalization.md Outdated Show resolved Hide resolved
docs/misc/components.md Outdated Show resolved Hide resolved
docs/misc/components.md Outdated Show resolved Hide resolved
docs/misc/components.md Outdated Show resolved Hide resolved
docs/misc/components.md Outdated Show resolved Hide resolved
docs/misc/components.md Outdated Show resolved Hide resolved
docs/misc/components.md Outdated Show resolved Hide resolved
docs/misc/components.md Outdated Show resolved Hide resolved
static/img/component_red_hello.png Outdated Show resolved Hide resolved
static/img/component_style_annotated.png Outdated Show resolved Hide resolved
@tmvkrpxl0 @ChampionAsh5357
Apply suggestions from code review
b9da264 
Co-authored-by: ChampionAsh5357 <championash5357@gmail.com>
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) July 30, 2023 11:25 Active
@tmvkrpxl0 @ChampionAsh5357
Forgot this one
6d37f6a 
Co-authored-by: ChampionAsh5357 <championash5357@gmail.com>
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) July 30, 2023 11:32 Active
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) July 31, 2023 09:16 Active
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) July 31, 2023 09:21 Active
ChampionAsh5357
ChampionAsh5357 requested changes Aug 1, 2023
View reviewed changes
Copy link
Contributor

@ChampionAsh5357 ChampionAsh5357 left a comment

Choose a reason for hiding this comment

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

Last batch I believe. Once again, any paragraphs should be combined into one line, not one line per sentence.

This:

This is a sentence. This is a second sentence.

Not this:

This is a sentence.  
This is a second sentence.

docs/misc/components.md Outdated Show resolved Hide resolved
docs/misc/components.md Outdated Show resolved Hide resolved
docs/misc/components.md Outdated Show resolved Hide resolved
docs/misc/components.md Outdated Show resolved Hide resolved
docs/misc/components.md Outdated Show resolved Hide resolved
docs/misc/components.md Outdated Show resolved Hide resolved
docs/misc/components.md Outdated Show resolved Hide resolved
docs/misc/components.md Outdated Show resolved Hide resolved
docs/misc/components.md Outdated Show resolved Hide resolved
docs/misc/components.md Outdated Show resolved Hide resolved
@tmvkrpxl0 @ChampionAsh5357
Apply suggestions from code review
f821e09 
Co-authored-by: ChampionAsh5357 <championash5357@gmail.com>
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) August 1, 2023 19:34 Active
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) August 3, 2023 08:29 Active
ChampionAsh5357
ChampionAsh5357 requested changes Aug 4, 2023
View reviewed changes
Copy link
Contributor

@ChampionAsh5357 ChampionAsh5357 left a comment

Choose a reason for hiding this comment

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

Missed a few more english stuff and a page link, but it should be done after this...probably.

docs/misc/components.md Outdated Show resolved Hide resolved
docs/misc/components.md Outdated Show resolved Hide resolved
docs/misc/components.md Outdated Show resolved Hide resolved
tmvkrpxl0 and others added 2 commits August 4, 2023 16:25
@tmvkrpxl0 @ChampionAsh5357
Apply suggestions from code review
5c6e19b 
Co-authored-by: ChampionAsh5357 <championash5357@gmail.com>
@tmvkrpxl0
Final batch (1)?
3986dd7
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) August 4, 2023 07:29 Active
@tmvkrpxl0 @ChampionAsh5357
oops
0332500 
Co-authored-by: ChampionAsh5357 <championash5357@gmail.com>
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) August 4, 2023 16:25 Active
ChampionAsh5357
ChampionAsh5357 approved these changes Aug 4, 2023
View reviewed changes
Copy link
Contributor

@ChampionAsh5357 ChampionAsh5357 left a comment

Choose a reason for hiding this comment

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

Everything seems fine now, let's see if I can merge it on mobile

@ChampionAsh5357 ChampionAsh5357 merged commit b9d295f into neoforged:main Aug 4, 2023
srcres258 added a commit to srcres258/neo-doc that referenced this pull request Oct 11, 2023
@srcres258
Sync translations for zh-CN from official
6101350 
b9d295f Add explanation for Component and ComponentContents (neoforged#4)

Signed-off-by: src_resources <src.res.211@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ChampionAsh5357 ChampionAsh5357 ChampionAsh5357 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@tmvkrpxl0 @ChampionAsh5357 @Matyrobbrt