Skip to content

Quick Bar dialog documentation#15033

Merged
frenck merged 11 commits intohome-assistant:nextfrom
donkawechico:quick_open_dialog_documentation
Oct 20, 2020
Merged

Quick Bar dialog documentation#15033
frenck merged 11 commits intohome-assistant:nextfrom
donkawechico:quick_open_dialog_documentation

Conversation

@donkawechico
Copy link
Copy Markdown
Contributor

@donkawechico donkawechico commented Oct 7, 2020

Proposed change

Documentation for new "quick open dialog" currently in progress here: home-assistant/frontend#7230

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

@probot-home-assistant probot-home-assistant Bot added has-parent This PR has a parent PR in another repo next This PR goes into the next branch Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest! labels Oct 7, 2020
@donkawechico
Copy link
Copy Markdown
Contributor Author

donkawechico commented Oct 7, 2020

Holy files changed! Must've based this off of current instead of next? Stand by...

Update: Resolved

@donkawechico donkawechico force-pushed the quick_open_dialog_documentation branch 4 times, most recently from d192da3 to 1bebe9e Compare October 7, 2020 20:28
@donkawechico donkawechico marked this pull request as ready for review October 7, 2020 20:30
@donkawechico donkawechico force-pushed the quick_open_dialog_documentation branch from 1bebe9e to bfa657d Compare October 7, 2020 20:32
Copy link
Copy Markdown
Contributor

@SeanPM5 SeanPM5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, just a few small review comments.

Comment thread source/_docs/tools/quick-open.md Outdated
Comment thread source/_docs/tools/quick-open.md Outdated
Comment thread source/_docs/tools/quick-open.md Outdated
Comment thread source/_docs/tools/quick-open.md Outdated
@donkawechico
Copy link
Copy Markdown
Contributor Author

Looks good, just a few small review comments.

Good catches! Resolved

@donkawechico
Copy link
Copy Markdown
Contributor Author

Parent pr merged

@donkawechico donkawechico force-pushed the quick_open_dialog_documentation branch from c31dcb2 to 31f5b13 Compare October 8, 2020 18:55
Co-authored-by: Sean Mooney <sean.mooney@gmail.com>
@donkawechico donkawechico force-pushed the quick_open_dialog_documentation branch from 31f5b13 to b0679c0 Compare October 8, 2020 19:03
@donkawechico
Copy link
Copy Markdown
Contributor Author

@SeanPM5 I took a look at the docs with fresh eyes and made a few small adjustments. Also had forgotten to add the page to the "Tools and Helpers" section of right nav.

Could you give it a quick re-review? Thanks

@frenck frenck added the parent-merged The parent PR has been merged already label Oct 9, 2020
SeanPM5
SeanPM5 previously approved these changes Oct 9, 2020
Copy link
Copy Markdown
Contributor

@SeanPM5 SeanPM5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The file extension should probably end in .markdown rather than .md for consistency sake with the rest of the docs repo.

I was a little iffy on all the mentions of “the application” because that could possibly confuse some readers into thinking of the mobile apps (which don’t support this feature yet). So I made a handful of suggestions to change those to just “frontend” instead.

Otherwise this looks good to me, approved. frenck or balloob should probably be the one to merge it though, not sure I'm allowed :P

P.S. - I dig the new Quick Bar name, and this is a seriously killer feature. Everyone’s going to absolutely love this, amazing contribution! 🎉

Comment thread source/_docs/tools/quick-bar.md Outdated
Comment thread source/_docs/tools/quick-bar.md Outdated
Comment thread source/_docs/tools/quick-bar.md
Comment thread source/_docs/tools/quick-bar.md Outdated
Comment thread source/_docs/tools/quick-bar.md
Comment thread source/_docs/tools/quick-bar.md Outdated
@SeanPM5 SeanPM5 changed the title Quick open dialog documentation Quick Bar dialog documentation Oct 9, 2020
Co-authored-by: Sean Mooney <sean.mooney@gmail.com>
donkawechico and others added 3 commits October 11, 2020 12:06
Co-authored-by: Sean Mooney <sean.mooney@gmail.com>
Co-authored-by: Sean Mooney <sean.mooney@gmail.com>
Co-authored-by: Sean Mooney <sean.mooney@gmail.com>
@donkawechico
Copy link
Copy Markdown
Contributor Author

One thing to note is that this feature may still work its way into the mobile apps (long-press, small hover-button, or gestures). At which point we should remember to update the docs to switch "frontend" back to something more general like application.

@donkawechico
Copy link
Copy Markdown
Contributor Author

donkawechico commented Oct 11, 2020

P.S. - I dig the new Quick Bar name, and this is a seriously killer feature. Everyone’s going to absolutely love this, amazing contribution! 🎉

Thanks @SeanPM5! I'm super excited about it. I've already caught myself trying to use the hotkey in my production instance and then getting annoyed that it isn't there yet 😆

Comment thread source/_docs/tools/quick-bar.markdown Outdated
This is similar to many modern developer-based applications like Sublime, VSCode, Chrome Developer Tools and GitHub file search do "quick file filter" searches.

This can be really helpful when you have LOTS of entities with the same substring (e.g. "\*.living_room_\*"), but you only care about a particular _domain_. For example, rather than type out "media_player.living_" to narrow down media players in your living room, you can just type, say, "med.livroom" and get back the same set with less typing.
This can be really helpful when you have LOTS of entities with the same substring (e.g., "\*.living_room_\*"), but you only care about a particular _domain_. For example, rather than type out "media_player.living_" to narrow down media players in your living room, you can just type, say, "med.livroom" and get back the same set with less typing.
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catches. TIL

@donkawechico
Copy link
Copy Markdown
Contributor Author

donkawechico commented Oct 20, 2020

We've pushed a lot of changes to quick bar in the last week. I should probably freshen this up before we release.

@frenck
Copy link
Copy Markdown
Member

frenck commented Oct 20, 2020

@donkawechico Well, now is the time, as the beta is being cut in a couple of hours.

@frenck
Copy link
Copy Markdown
Member

frenck commented Oct 20, 2020

Do you want me to hold this PR? Or do you want to create a new one?

@donkawechico
Copy link
Copy Markdown
Contributor Author

Do you want me to hold this PR? Or do you want to create a new one?

Please go ahead merge if I don't push changes before the cut. The differences are not a big deal.

@frenck frenck merged commit 0a9a8f2 into home-assistant:next Oct 20, 2020
@probot-home-assistant probot-home-assistant Bot removed the parent-merged The parent PR has been merged already label Oct 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest! has-parent This PR has a parent PR in another repo next This PR goes into the next branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants