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

Rework the Client Resources chapter #62

Merged
merged 46 commits into from
Apr 19, 2024

Conversation

IchHabeHunger54
Copy link
Member

@IchHabeHunger54 IchHabeHunger54 commented Mar 26, 2024

Probably the biggest rework yet: the Resources chapter. I originally wanted to redo the entire Resources chapter at once, but given the sheer scope of that, I decided to split it into two: client and server. So client resources rework first it is.

This PR:

  • Reworks the old Resources article, explaining the similarities and differences between assets/data and resource/data packs, as well as giving a brief overview about what datagen is.
  • Adds a new article about I18n and L10n. This article replaces the I18n article in the Concepts section, the Component article in the Misc section, and the Language Datagen article.
  • Adds new articles about particles and sounds. These articles replaces the Particles and Sounds articles in the Game Effects section, as well as the Sound Definition Datagen article.
  • Adds a new article about textures and texture metadata.
  • Adds several new articles in relation to models. These are rewritten, condensed and updated versions of the various mini-articles in the Rendering folder, the old articles in the Models folder, and the old Model Datagen article. Information about several previously undocumented features, such as baked model wrappers, was added as well.
  • Does a fair bit of restructuring. The Rendering and Game Effects folders are gone, as their contents were merged into the Client Resources folder. The client datagen folder is gone as well; as a result, the server datagen was moved to the root of the datagen folder.
  • Changes the Contribution Guidelines to use json5 for JSON blocks instead of js (to allow comments), as discussed on Discord. This guideline change is not applied to existing articles, only to new ones.
  • Deletes a few now-unused pictures.
  • Changes links as needed.

I made a few general design decisions in this PR that I'd like to outline here:

  • Merge datagen articles into their respective "base articles" (lang datagen -> lang article, sounds datagen -> sounds article, etc.)
  • Merge articles together. Instead of the previous 12 articles about model stuff, we have 4 now. These contain more content and are significantly longer, notably because I wanted to avoid single-page articles like the Tinting article. This philosophy can (and I imagine, will) be discussed, and I'm open to suggestions on what to change here.
  • Use more examples. If there was one thing that was bad about the old docs, it was the lack of examples to work with. Just mentioning the methods is not a bad idea per se, but I see nothing wrong with also providing copy-paste base structures to work off. You need to insert your own names and stuff anyway. However, I do recognize that this contributes a lot to the length of some articles.

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

IchHabeHunger54 and others added 30 commits January 29, 2024 18:04
Co-authored-by: Dennis C <xfacthd@gmx.de>
Co-authored-by: Dennis C <xfacthd@gmx.de>
Co-authored-by: ChampionAsh5357 <championash5357@gmail.com>
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) March 26, 2024 01:54 Active
@neoforged-pages-deployments
Copy link

neoforged-pages-deployments bot commented Mar 26, 2024

Deploying with Cloudflare Pages

Name Result
Last commit: ed4e02b12ca5787c40afec1b98b7ad7c1205635b
Status: ✅ Deploy successful!
Preview URL: https://a0dc2c16.neoforged-docs-previews.pages.dev
PR Preview URL: https://pr-62.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.

Very nice, here are my overall comments.

docs/resources/client/models/bakedmodel.md Outdated Show resolved Hide resolved
docs/resources/client/models/bakedmodel.md Outdated Show resolved Hide resolved
docs/resources/client/models/datagen.md Outdated Show resolved Hide resolved
docs/resources/client/models/datagen.md Show resolved Hide resolved
docs/resources/client/models/index.md Outdated Show resolved Hide resolved
docs/resources/client/models/modelloaders.md Outdated Show resolved Hide resolved
docs/resources/client/particles.md Show resolved Hide resolved
docs/resources/index.md Outdated Show resolved Hide resolved
docs/resources/index.md Outdated Show resolved Hide resolved
docs/resources/index.md Show resolved Hide resolved
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) March 28, 2024 17:51 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.

One more thought and the remaining unresolved comments. Otherwise, looks good

docs/resources/client/models/index.md Show resolved Hide resolved
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) March 31, 2024 19:07 Active
Copy link
Member

@embeddedt embeddedt left a comment

Choose a reason for hiding this comment

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

I only looked at the baked model stuff I am familiar with.

docs/resources/client/models/bakedmodel.md Outdated Show resolved Hide resolved
docs/resources/client/models/bakedmodel.md Outdated Show resolved Hide resolved
docs/resources/client/models/bakedmodel.md Outdated Show resolved Hide resolved
docs/resources/client/models/bakedmodel.md Outdated Show resolved Hide resolved
docs/resources/client/models/bakedmodel.md Show resolved Hide resolved
docs/resources/client/i18n.md Outdated Show resolved Hide resolved
docs/resources/client/i18n.md Outdated Show resolved Hide resolved
docs/resources/client/i18n.md Outdated Show resolved Hide resolved
docs/resources/client/models/bakedmodel.md Outdated Show resolved Hide resolved
docs/resources/client/models/bakedmodel.md Outdated Show resolved Hide resolved
docs/resources/client/sounds.md Outdated Show resolved Hide resolved
docs/resources/client/sounds.md Outdated Show resolved Hide resolved
docs/resources/client/textures.md Outdated Show resolved Hide resolved
docs/resources/index.md Outdated Show resolved Hide resolved
docs/resources/index.md Outdated Show resolved Hide resolved
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) April 17, 2024 17:34 Active
docs/resources/client/models/bakedmodel.md Outdated Show resolved Hide resolved
docs/resources/client/models/bakedmodel.md Outdated Show resolved Hide resolved
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) April 18, 2024 21:35 Active
Copy link
Member

@XFactHD XFactHD left a comment

Choose a reason for hiding this comment

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

:shipit:

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.

Looks fine.

@XFactHD XFactHD merged commit 6369904 into neoforged:main Apr 19, 2024
1 check passed
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.

None yet

4 participants