Skip to content

Commit

Permalink
docs: more updates for docs
Browse files Browse the repository at this point in the history
  • Loading branch information
denysdovhan committed May 24, 2024
1 parent c9c6c96 commit 87e5410
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 89 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Denys Dovhan Smart Home

![Home](https://user-images.githubusercontent.com/3459374/152371766-1d2a1e17-34d3-4fe6-9e6d-aded02f14de1.png)
![Smart Home dashboard overview](https://github.com/denysdovhan/smart-home/assets/3459374/3eb9c007-4443-4e8d-98bf-cce0e85d631e)

[![GitHub Workflow Status][github-img]][github-url]
[![Last Commit][last-commit-img]][github-url]
Expand All @@ -11,7 +11,7 @@
[![GitHub Stars][stars-img]][github-url]
[![Twitter Followers][twitter-img]][twitter-url]

This is my personal Home Assistant configuration, awakening my home with automations. I hope this will help you inspire on the way to built your own smart home.
This is my personal smart-home configuration, awakening my home with services and tools. I hope this will help you inspire on the way to built your own smart home.

[**Read the documentation**](https://denysdovhan.com/smart-home)

Expand All @@ -24,7 +24,7 @@ I also have a [public Notion board](https://www.notion.so/denysdovhan/f09ea06da5
<!-- References -->

[github-url]: https://github.com/denysdovhan/smart-home
[github-img]: https://img.shields.io/github/actions/workflow/status/denysdovhan/smart-home/homeassistant.yml?style=flat-square
[github-img]: https://img.shields.io/github/actions/workflow/status/denysdovhan/smart-home/docs.yml?style=flat-square
[last-commit-img]: https://img.shields.io/github/last-commit/denysdovhan/smart-home?style=flat-square
[commit-activity-img]: https://img.shields.io/github/commit-activity/m/denysdovhan/smart-home?style=flat-square
[license-url]: https://github.com/denysdovhan/smart-home/blob/master/LICENSE
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Welcome to my Smart Home!

![Screenshot 2024-05-24 at 18 48 01](https://github.com/denysdovhan/smart-home/assets/3459374/3eb9c007-4443-4e8d-98bf-cce0e85d631e)
![Smart Home dashboard overview](https://github.com/denysdovhan/smart-home/assets/3459374/3eb9c007-4443-4e8d-98bf-cce0e85d631e)

[![GitHub Workflow Status][github-img]][github-url]
[![Last Commit][last-commit-img]][github-url]
Expand Down
25 changes: 25 additions & 0 deletions docs/software/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Introduction

This page describes my system setup. Here you can find software I rely on for running my smart home system.

## Using Proxmox

## Ubuntu LXC

I use [Ubuntu](https://ubuntu.com/) as a primary OS for my Raspberry Pi. Ubuntu is a well-maintained Linux distribution with a huge community and large support forums.

It officially [supports Raspberry Pi](https://ubuntu.com/download/raspberry-pi) and can be easily installed via the official Raspberry Pi Imager.

## [Docker](https://www.docker.com/)

I use [Docker](https://www.docker.com/) for managing all containers in my smart home.

Docker allows to encapsulate everything related to a single service within a container. This approach helps to maintain host system clean and manage (start, stop, update and delete) every container separately.

### Enabling hardware acceleration

## smart-home CLI

This is just a bash script I wrote for personal need. You can [find it here](https://github.com/denysdovhan/smart-home/blob/master/bin/smart-home).

This performs typical tasks I do in my smart home, like bootstraping, controlling server, updating, etc.
28 changes: 0 additions & 28 deletions docs/software/ports.md

This file was deleted.

55 changes: 0 additions & 55 deletions docs/software/system.md

This file was deleted.

3 changes: 1 addition & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -52,13 +52,12 @@ nav:
- Home: index.md
- Hardware: hardware.md
- Software:
- software/system.md
- software/index.md
- software/getting-started.md
- software/docker.md
- software/media.md
- software/external-access.md
- software/ad-blocking.md
- software/ports.md
- Inspiration: resources.md
# Link to my smart-home setup
# Ref: https://github.com/denysdovhan/home-assistant-config
Expand Down

0 comments on commit 87e5410

Please sign in to comment.