neoforged / Documentation

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

update capability documentation for planned refactor #13

Closed justliliandev closed 6 months ago

justliliandev commented 9 months ago

Updates the capability documentation to match the capability refactor https://github.com/neoforged/NeoForge/pull/73 I try to keep parity to the PR if further changes happen.


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

ChampionAsh5357 commented 9 months ago

I'm assigning myself so I can keep track of this. Request a review whenever you want me to take a look in its current state. This should probably be a draft until it gets merged.

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

Deploying with Cloudflare Pages

Name Result
Last commit: 1892a52ef0fe616441aeaef5e2b97f0286f9abcc
Status: ✅ Deploy successful!
Preview URL: https://995e9b8b.neoforged-docs-previews.pages.dev
PR Preview URL: https://pr-13.neoforged-docs-previews.pages.dev
justliliandev commented 9 months ago

I'll probably reword and add a few things here and there (like the BlockCapabilityCache), but I would like to get an opinion: Where should the Capabilities Page go? It's currently under the data storage category, even though caps don't do that anymore. Should the page stay there to keep links working? Or which category should the page be put under?

ChampionAsh5357 commented 9 months ago

It's probably better to rename the entire section since caps, attachment data, and saved data are roughly the same category in my mind. Maybe something like 'extensions'?

justliliandev commented 9 months ago

I've decided against the rename of the group to extensions, because that would exclude Codecs from the group and would clash with the Concepts of Extension Interfaces that are added by Neo

ChampionAsh5357 commented 6 months ago

Closing because of #34. Thank you for the work so far though!