Digital-Alchemy-TS / Digital-Alchemy-TS/documentation

Quickstart Documentation

Open
#3 0 comments 1 reaction 0 assignees View on GitHub
enhancement
Dominant language
TypeScript
Stars
1
Forks
5
PR merge metrics
No merged PRs in 30d

Description

## 🪤 Context
Hi,

Love the project! This is some feedback/suggestions for the quickstart documentation as someone who is brand new to Digital Alchemy.

After installing Digital Alchemy with `quick start` I don't really know where to go from there. Or if its working as intended. Would be nice to add some more steps / instructions on how to get going.

1. How do I know everything is working?

I'm not sure if this exists but you could add a demo automation that fires when digital alchemy is running & working and logs something to home assistant to confirm everything is good to go. Explain how to run digital alchemy for the first time and where to look for the output of the demo automation.

2. How do i create my first automation?

Add a section to walk through how to create your first automation with digital alchemy. Explain how to do it step by step and how to confirm it works, etc.

There is a ton of great information in your docs but its hard to get started. A fundamentals guide that walks you through some examples would be great. If this stuff already exists I'd link it on the quickstart doc so people know where to start looking.

Thanks again for creating this project so cool!

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.