Documentation
Documentation copied to clipboard
Update the Documentation to Match Contributing Guidelines
The contributing guidelines have recently been established, so every page needs to be updated to support the new guidelines. To that end, every page will be reviewed and rewritten/reformatted as required. The changes should target the at-the-time latest version of NeoForge.
I have assigned myself since I will eventually redo all the pages, but anyone is welcome to help contribute.
- [x] Getting Started with Neo #28
- [x] Mod Files #28
- [x] Structuring Your Mod #28
- [x] Versioning #28
- [x] Concepts
- [x] Events #48
- [x] Internationalization and Localization #62 (merged into Resources/Client/I18n and L10n)
- [x] Mod Lifecycle #48 (merged into Events)
- [x] Registries #48
- [x] Resources #48 (moved to Miscellaneous/Resource Locations)
- [x] Sides in Minecraft #48 (renamed to Sides)
- [x] Blocks #21
- [x] Block States #21
- [x] Items #39
- [x] BlockEntityWithoutLevelRenderer #160 (merged into Block Entities/Block Entity Renderers)
- [x] Block Entities #160
- [x] BlockEntityRenderer #160
- [x] Resources #62
- [x] Resource Packs #62 (renamed to Client)
- [x] Models #62
- [x] Item Properties #62 (merged into Models)
- [x] Coloring Textures #62 (merged into Models)
- [x] Models #62
- [x] Datapacks #111 (renamed to Server)
- [x] Advancements #45
- [x] Conditionally-Loaded Data #111 (renamed to Data Load Conditions)
- [x] Global Loot Modifiers #111 (moved to Loot Tables/Global Loot Modifiers)
- [x] Loot Tables #111
- [x] Recipes #111
- [x] Custom Recipes #111 (merged into Recipes)
- [x] Non-Datapack Recipes #111 (merged into Recipes)
- [x] Ingredients #111
- [x] Tags #111
- [x] Resource Packs #62 (renamed to Client)
- [x] Data Generators #62 (merged into Resources)
- [x] Client #62 (removed)
- [x] Language Generation #62 (merged into Resources/Client/I18n and L10n)
- [x] Model Generation #62 (moved to Resources/Client/Models/Model Datagen)
- [x] Sound Definition Generation #62 (merged into Resources/Client/Sounds)
- [x] Server #111
- [x] Advancement Generation #111 (merged into Resources/Server/Advancements)
- [x] Datapack Registry Object Generation #48 (merged into Concepts/Registries)
- [x] Global Loot Modifier Generation #111 (merged into Resources/Server/Loot Tables/Global Loot Modifiers)
- [x] Loot Table Generation #111 (merged into Resources/Server/Loot Tables)
- [x] Recipe Generation #111 (merged into Resources/Server/Recipes)
- [x] Tag Generation #111 (merged into Resources/Server/Tags)
- [x] Client #62 (removed)
- [x] Game Effects #62 (removed)
- [x] Particles #62 (moved to Resources/Client/Particles)
- [x] Sounds #62 (moved to Resources/Client/Sounds)
- [x] Rendering #62 (removed)
- [x] Model Extensions #62 (removed)
- [x] Face Data #62 (merged into Resources/Client/Models)
- [x] Render Types #62 (merged into Resources/Client/Models)
- [x] Root Transforms #62 (merged into Resources/Client/Models)
- [x] Part Visibility #62 (merged into Resources/Client/Models)
- [x] Custom Model Loaders #62 (moved to Resources/Client/Models/Custom Model Loaders)
- [x] BakedModel #62 (moved to Resources/Client/Models/Baked Models)
- [x] ItemOverrides #62 (merged into Resources/Client/Models/Baked Models)
- [x] Transform #62 (merged into Resources/Client/Custom Model Loaders)
- [x] Model Extensions #62 (removed)
- [ ] Data Storage
- [x] The Capability System #34
- [ ] Codecs
- [ ] Saved Data
- [ ] GUIs
- [ ] Menus
- [ ] Screens
- [x] Networking #42
- [x] Entities #42
- [x] SimpleImpl #42
- [ ] Advanced Topics
- [ ] Access Transformers
- [ ] Miscellaneous
- [x] Text Components #62 (merged into Resources/Client/I18n and L10n)
- [ ] Configuration
- [ ] Debug Profiler
- [ ] Game Tests
- [ ] Key Mappings
- [ ] Forge Update Checker
- [ ] Legacy
- [ ] Porting to Minecraft 1.20
TODO Section
These are a list of docs that are needed or highly recommended to have on NeoForged.
- [ ] Entities #90
- [x] Data Components #75
- [x] Stream Codecs #80
- [ ] Contributing to NeoForge
- [x] IExtensibleEnum #78
Speaking of which, recent changes to Capability document doesn't follow new style guide. https://github.com/neoforged/Documentation/blob/main/docs/datastorage/capabilities.md?plain=1#L7-L8 These should be 1 line.
Well aware of this. I have decided to do a passthrough at a later point in time since there were some disagreements about whether formatting should be essential towards contribution or fixed after merging by the maintainers of the docs repo.
Is there any way I can contribute to this?
I spent a decent chunk of last night wrestling with the Advancements page being pretty out of date so I would love to pass on what I've now puzzled out and update the examples there, but if something is already in progress I don't want to step on any toes!
If there's not an open PR, it's likely not being worked on yet.
Currently IHH is the main person updating sections. I will be joining in once my new laptop decides to ship.