neoforged / Documentation

The repository containing Neo's documentation
MIT License
23 stars 36 forks source link

Explain blocks and blockstates in more depth #21

Closed IchHabeHunger54 closed 7 months ago

IchHabeHunger54 commented 8 months ago

This PR improves and expands on the explanation of blocks and blockstates. More specifically, it:


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

neoforged-pages-deployments[bot] commented 8 months ago

Deploying with Cloudflare Pages

Name Result
Last commit: a8b4c53e22a511c2a491b4abfbd71d7b63aeb385
Status: ✅ Deploy successful!
Preview URL: https://b248ddeb.neoforged-docs-previews.pages.dev
PR Preview URL: https://pr-21.neoforged-docs-previews.pages.dev
IchHabeHunger54 commented 8 months ago

I was under the impression that we held to the old project's standard of not including example code in the docs. As I understand it, this has changed, so I will update the PR accordingly.

ChampionAsh5357 commented 8 months ago

Yeah, generally prefer pseudocode like java with comments over exact examples unless necessary. The guidelines should show an example

IchHabeHunger54 commented 8 months ago

Rewrote major parts of it to consider the feedback, examples have been added. I also added a WIP method reference page that I will finish tomorrow (hopefully). Converting to draft for now.

IchHabeHunger54 commented 8 months ago

I also dismissed most of the feedback since I fixed most of it when rewriting ("fixed" from my point of view). If there are problems with it still, feel free to re-add feedback as needed.

embeddedt commented 8 months ago

I am not sure what's happening (could be a bug on my end), but it seems like many of the issues raised in the review comments are still present in the diff view on GitHub, despite the comment being marked as resolved.

IchHabeHunger54 commented 8 months ago

Yes, I forgot to push.

IchHabeHunger54 commented 7 months ago

I decided to use EndPortalFrameBlock as an example rather than AbstractFurnaceBlock, as it doesn't have any block entity things going on that might lead to confusion when new modders decide to look there for an example.