Add comprehensive documentation for actions and best practices #24
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
**Changes:** - Introduced new documentation pages: `actions.md`, `best-practices.md`, `conditions.md`, and `examples.md`, providing detailed guidelines and examples. - `actions.md`: Detailed the structure and purpose of custom actions, web mappings, and callback usage. - `best-practices.md`: Provided conventions for naming, resource organization, and testing strategies. - `conditions.md`: Explained the role of conditions in feature logic with practical patterns. - `examples.md`: Demonstrated the implementation of features and their real-world applications. This extensive documentation ensures developers have robust guidelines for implementing and managing features.
**Changes:** - Updated section headers in `README.md` to include emojis, improving visual organization. - Refined "Documentation" section to include a link to the official site, `featury.servactory.com`, for guides and API documentation. - Enhanced "Why Featury?" section with bullet points for better clarity and readability. - Added acknowledgment of contributors and polished the "Contributing" section with a welcoming tone. - Mirrored documentation updates in `docs/README.md` to ensure consistency in links and quick references. These changes enhance readability, navigation, and access to comprehensive resources for users and contributors.
**Changes:**
- Refactored condition blocks in all documentation files to consistently use the `lambda { |resources:| ... }` syntax, replacing the `->` syntax for better readability and alignment with convention.
- Added detailed action examples (`add`, `disabled?`, `enable`, `disable`) across multiple documentation pages (`actions.md`, `best-practices.md`, `features.md`, `groups.md`, `examples.md`).
- Enhanced section descriptions in `best-practices.md` and `examples.md` to better highlight use cases and demonstrate practical feature implementations.
- Removed outdated examples and redundant sections (`AdminController`, `MaintenanceFeature`) from relevant documents to streamline content.
These updates improve clarity, consistency, and accessibility for developers using the documentation.
**Changes:**
- Updated all `lambda {}` condition blocks to consistently use the `do...end` syntax for improved readability.
- Enhanced examples in `best-practices.md`, `examples.md`, and `conditions.md` with additional context and updated feature logic.
- Adjusted test cases for `onboarding` conditions to include checks for new feature flags in `best-practices.md` and `conditions.md`.
- Applied syntax adjustments to improve alignment with Ruby conventions across documentation files.
These updates streamline documentation, improve readability, and ensure cohesive examples for developers.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.