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

Add explanation for Component and ComponentContents #4

Merged
merged 17 commits into from
Aug 4, 2023

Conversation

tmvkrpxl0
Copy link
Contributor

@tmvkrpxl0 tmvkrpxl0 commented Jul 23, 2023

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

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.

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
@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

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
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
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) July 30, 2023 11:25 Active
Co-authored-by: ChampionAsh5357 <[email protected]>
@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
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
@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
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
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) August 4, 2023 07:29 Active
Co-authored-by: ChampionAsh5357 <[email protected]>
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) August 4, 2023 16:25 Active
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
1 check passed
srcres258 added a commit to srcres258/neo-doc that referenced this pull request Oct 11, 2023
b9d295f Add explanation for Component and ComponentContents (neoforged#4)

Signed-off-by: src_resources <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants