-
-
Notifications
You must be signed in to change notification settings - Fork 56
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.
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
Add Feature Flags documentation #184
Conversation
Deploying with Cloudflare Pages
|
a684159
to
5242892
Compare
It may be better for readability to move the external section below the built-in section |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the contribution, and sorry for taking so long. This is looking quite good for a first version, the explanations are well done, and most change requests are of grammatical or structural nature.
A few things occurring across the entire documentation, which I'd ask you to change, are:
- The term "Feature Flags" is often capitalized. Terms like that should not be capitalized outside of headings. Otherwise we'd have to capitalize Block and Item every single time as well, which just looks weird.
- Please ensure that there is one blank line before and after each code block.
- Use H2s and H3s instead of H3s and bold paragraphs.
Co-authored-by: IchHabeHunger54 <[email protected]>
And reference other resources
Move Built-in above External
Add tip about being able to use vanilla flags
62d03b5
to
99849be
Compare
Initial rough write up of documentation for custom feature flags.
Goes over how to register and lookup a custom flag, mark elements as requiring said flag and how provide a feature pack to allow users to enable said flag.
Documentation can be found under
NeoForge Documentation > Advanced Topics
This depends on either of the existing flag prs neoforged/NeoForge#1619 neoforged/NeoForge#1538
First time writing documentation like this, please let me know how/where I can improve anything.
Preview URL: https://pr-184.neoforged-docs-previews.pages.dev