Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document basics for new users #10

Open
ironicbadger opened this issue Oct 10, 2020 · 2 comments
Open

Document basics for new users #10

ironicbadger opened this issue Oct 10, 2020 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@ironicbadger
Copy link

Aimed at new users (not devs). How do they get started?
@ironicbadger ironicbadger added the documentation Improvements or additions to documentation label Oct 10, 2020
@RealOrangeOne
Copy link
Member

Documentation for this to live in a docs/ directory in the root of the repo, simply as markdown files.

How these are served can be defined later. First step is have some documentation to serve.

@sthi0460
Copy link

Would it be possible to include a sample config.yml file in the repo? I have a HA instance setup and wanted to test this code, but I do not know what should go into the config file.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@ironicbadger @RealOrangeOne @sthi0460