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.

Sign up for GitHub

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

Jump to bottom

Update the Documentation to Match Contributing Guidelines #20

Open
46 of 83 tasks
ChampionAsh5357 opened this issue Oct 11, 2023 · 4 comments
Open
46 of 83 tasks

Update the Documentation to Match Contributing Guidelines #20

ChampionAsh5357 opened this issue Oct 11, 2023 · 4 comments
Assignees
@ChampionAsh5357

Comments

@ChampionAsh5357
Copy link
Contributor

ChampionAsh5357 commented Oct 11, 2023 •
edited

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 will target the 20.2 version of NeoForge when released.

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.
@ChampionAsh5357 ChampionAsh5357 self-assigned this Oct 11, 2023
@ChampionAsh5357 ChampionAsh5357 mentioned this issue Oct 21, 2023
Merged
@tmvkrpxl0
Copy link
Contributor

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
Copy link
Contributor Author

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
Copy link
Contributor

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
Copy link
Contributor Author

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.

@legobmw99 legobmw99 mentioned this issue Jan 14, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ChampionAsh5357 ChampionAsh5357

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@legobmw99 @ChampionAsh5357 @tmvkrpxl0