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.

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

Merged
merged 19 commits into from
Nov 15, 2024

Conversation

ApexModder
Copy link
Contributor

@ApexModder ApexModder commented Oct 24, 2024

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

@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) October 24, 2024 00:19 Active
@neoforged-pages-deployments
Copy link

neoforged-pages-deployments bot commented Oct 24, 2024

Deploying with Cloudflare Pages

Name Result
Last commit: 99849bef05f4931d27c47480701120323b0b2d09
Status: ✅ Deploy successful!
Preview URL: https://88d9d96f.neoforged-docs-previews.pages.dev
PR Preview URL: https://pr-184.neoforged-docs-previews.pages.dev

@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) October 24, 2024 06:47 Active
@IchHabeHunger54 IchHabeHunger54 added the addition Adding or rewriting information. label Oct 29, 2024
@IchHabeHunger54 IchHabeHunger54 mentioned this pull request Oct 29, 2024
20 tasks
@ApexModder ApexModder marked this pull request as ready for review November 13, 2024 18:26
@neoforged-pages-deployments neoforged-pages-deployments bot requested a deployment to neoforged-docs-previews (Preview) November 13, 2024 18:27 Abandoned
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) November 13, 2024 18:28 Active
@thomasglasser
Copy link

It may be better for readability to move the external section below the built-in section

Copy link
Member

@IchHabeHunger54 IchHabeHunger54 left a 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.

docs/advanced/featureflags.md Outdated Show resolved Hide resolved
docs/advanced/featureflags.md Show resolved Hide resolved
docs/advanced/featureflags.md Outdated Show resolved Hide resolved
docs/advanced/featureflags.md Outdated Show resolved Hide resolved
docs/advanced/featureflags.md Outdated Show resolved Hide resolved
docs/advanced/featureflags.md Outdated Show resolved Hide resolved
docs/advanced/featureflags.md Outdated Show resolved Hide resolved
docs/advanced/featureflags.md Outdated Show resolved Hide resolved
docs/advanced/featureflags.md Outdated Show resolved Hide resolved
docs/advanced/featureflags.md Outdated Show resolved Hide resolved
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) November 14, 2024 16:04 Active
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) November 14, 2024 17:24 Active
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) November 14, 2024 17:32 Active
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) November 14, 2024 22:40 Active
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) November 14, 2024 22:54 Active
@IchHabeHunger54 IchHabeHunger54 merged commit 71deca5 into neoforged:main Nov 15, 2024
1 check passed
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) November 15, 2024 22:43 Active
@ApexModder ApexModder deleted the pr/feature-flags branch November 16, 2024 00:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
addition Adding or rewriting information.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants