Feature: Add support for hiding other domains in the Miscellaneous section#344
Open
DigiLive wants to merge 7 commits into
Open
Feature: Add support for hiding other domains in the Miscellaneous section#344DigiLive wants to merge 7 commits into
DigiLive wants to merge 7 commits into
Conversation
- Improved cache clearing documentation in the FAQ to clarify browser behavior with Developer Tools and cache disabling. - Fixed a typo in the installation guide for better accuracy and consistency.
- Added support for specifying `hidden_domains` in the `default` domain configuration. This allows excluding unsupported domains from being displayed while improving flexibility in strategy configurations. - Updated TypeScript interfaces to accommodate these changes, ensuring type safety and accurate structure representation.
- Added `docs:install` script to set up a Python virtual environment and install dependencies from `requirements.txt`. - Updated `docs:serve` and `docs:serve-versioned` scripts to activate the virtual environment before running `mkdocs` and `mike`.
- Added `hidden_domains` option under the `default` domain, enabling hiding of specific domains in the 'Miscellaneous' section of an Area view.
Up to standards ✅🟢 Issues
|
| Metric | Results |
|---|---|
| Complexity | 0 |
NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.
There was a problem hiding this comment.
Pull request overview
This PR adds a new configuration option to hide specific entity domains from the “Miscellaneous” (default) section in an Area view, addressing the need to quickly exclude unsupported domains like automation and script.
Changes:
- Introduces
domains.default.hidden_domainsin the strategy configuration types and defaults. - Filters entity registry entries based on
hidden_domainsduringRegistryinitialization. - Updates documentation/examples to describe and demonstrate the new option (plus a few unrelated doc/script edits).
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| src/types/strategy/strategy-generics.ts | Adds DefaultDomainConfig and wires it into the domains typing. |
| src/Registry.ts | Filters out entities whose domain is listed in domains.default.hidden_domains. |
| src/configurationDefaults.ts | Adds hidden_domains: [] to the default domain config. |
| package.json | Modifies documentation scripts (now Windows-specific) and adds docs:install. |
| docs/options/domain-options.md | Documents hidden_domains under the default domain and updates explanatory text. |
| docs/getting-started/installation.md | Fixes a typo (“browers” → “browsers”). |
| docs/full-example.md | Adds an example showing domains.default.hidden_domains. |
| docs/faq.md | Adjusts guidance for reloading dashboards after manual install. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Removed Python virtual environment activation from `docs:serve` and `docs:serve-versioned` scripts to simplify usage. - This change assumes the user has the required dependencies installed globally, reducing script complexity.
- Changed the `hidden_domains` property in `DefaultDomainConfig` from optional to required in `strategy-generics.ts`.
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
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.
Feature Pull Request
Feature Summary
The Miscellaneous section of an Area view, shows card of any other domain than supported by the strategy.
This feature allows the user to list entity-domains to exclude from this section.
Motivation and Context
Resolves #332.
It de-clutters the Miscellaneous section by hiding entities a user doesn't usually control.
E.g. Automations, Scripts, Events, etc.
List of Changes
hidden_domainsin thedefaultdomain configuration.Documentation Updates
hidden_domainsoption under thedefaultdomain, enabling hiding of specific domains in the 'Miscellaneous' section of an Area view.Agreements
Please confirm the following by inserting an
xbetween the brackets: