keatontaylor / alexa-actions

A README and associated code to get actionable notifications setup for Alexa devices.
GNU General Public License v3.0
399 stars 187 forks source link

Ideas for the wiki #135

Closed elmar-hinz closed 1 year ago

elmar-hinz commented 1 year ago

I plan to rework the Wiki. That's what I consider to do. What do you think?

Installation

Document the new import feature as the standard way to install. Move the classical way (copying single files) to a separate page, while keeping it available as a fallback solution.

Hello world

The page Setting up your first actionable notification is describing a door. Not everybody is in possession of a smart lock. I would like to move this to the examples section and do something more simple, basically a question for yes or no.

The yes-no question is also suitable to describe it as a simple node red flow, to offer an alternative starting point.

DEADSEC-SECURITY commented 1 year ago

Yup seems like a good idea. If you need help let me know. Do you have discord or something like that. Probably easier if you need to ask me anything.

elmar-hinz commented 1 year ago

Screenshot 2022-12-29 at 10 10 50

This is hello world done in node red, to visualise the simplicity. With traditional automation I would replace trigger and debugger with a virtual button and light.

DEADSEC-SECURITY commented 1 year ago

@elmar-hinz are you authorized to vhange the wiki? Can you send a copy of the template code?

DEADSEC-SECURITY commented 1 year ago

We should also include a section for people contributing for new languages explaining what files need to be modded

DEADSEC-SECURITY commented 1 year ago

Updated the wiki to reflect this. Just the home page for now https://github.com/keatontaylor/alexa-actions/wiki image

DEADSEC-SECURITY commented 1 year ago

@elmar-hinz can you confirm if you modded the wiki? I dont want to be overwriting your stuff

elmar-hinz commented 1 year ago

Yes, I can edit the wiki. I guess everybody is allowed to do.

elmar-hinz commented 1 year ago

@DEADSEC-SECURITY I am currently not working the wiki. I am preparing the supper. Maybe I find some time after midnight, European time.

elmar-hinz commented 1 year ago

Current state

TODO

DONE:

elmar-hinz commented 1 year ago

About troubleshooting pages

I tried to avoid a lot of troubles upfront by giving prerequisites, screenshots and showing how to do intermediate success checking.

With improved import and documentation more ppl will use the skill. That in turn may bring on more issue tickets. To really know, where troubles pop up, we just have to see.

The issue with the wife's account was quite interesting. On the first glance, it looks like a funny human assumption, that the devices within the same room are reachable, even if they belong to different Amazon accounts.

Having a deeper look, all devices are connected to Home Assistant. Home Assistant doesn't know about different Amazon accounts. All devices within the home are connected to it. Home Assistant actually suggests the wife's devices for selection. So this issue may occur more often, than you would initially anticipate.

DEADSEC-SECURITY commented 1 year ago

New issue report is coming which should help us with this.

DEADSEC-SECURITY commented 1 year ago

https://github.com/keatontaylor/alexa-actions/blob/master/.github/ISSUE_TEMPLATE/bug_report.yml new issue report done. Let me know if you think we should add anything relevant

DEADSEC-SECURITY commented 1 year ago

Ill see if I work on the TODOs too because those are important. If you start anything let me know so we dont do the same thing at the same time @elmar-hinz

elmar-hinz commented 1 year ago

I close this ticket for now. The original concerns of Hello World and Installation are fully done by Getting Started of the Wiki meanwhile.

The issue template is a different topic.