neoforged / Documentation

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

Update the Documentation to Match Contributing Guidelines #20

Open ChampionAsh5357 opened 8 months ago

ChampionAsh5357 commented 8 months ago

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.

TODO Section

These are a list of docs that are needed or highly recommended to have on NeoForged.

tmvkrpxl0 commented 6 months ago

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.

ChampionAsh5357 commented 6 months ago

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.

legobmw99 commented 5 months ago

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!

ChampionAsh5357 commented 5 months ago

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.