Documentation (#769)
* spelling correction * Restuctured, added "features", "supported hardware", intro for developers and links to the developer documentation. * Spelling correction * URL correction * Documentation restructure * Moving developer documentation index from top level README to Documentation directory README * fixing URLS * Restructuring and adding to board config * Improving navigation of docs oon github * New line after first heading (https://github.com/home-assistant/operating-system/pull/768#discussion_r453336692) Co-authored-by: Franck Nijhof <frenck@frenck.nl> * Update README.md https://github.com/home-assistant/operating-system/pull/768#discussion_r453336871 Co-authored-by: Franck Nijhof <frenck@frenck.nl> * Update README.md (https://github.com/home-assistant/operating-system/pull/768#discussion_r453336999) - Surround headings with newlines - ODROID - Use dashes for unordered lists Co-authored-by: Franck Nijhof <frenck@frenck.nl> * Update README.md - new line after heading (https://github.com/home-assistant/operating-system/pull/768#discussion_r453337043) Co-authored-by: Franck Nijhof <frenck@frenck.nl> * Update README.md - \- for unordered lists - new line after heading (https://github.com/home-assistant/operating-system/pull/768#discussion_r453337101) Co-authored-by: Franck Nijhof <frenck@frenck.nl> * Update README.md - new line after heading - \- for unordered lists (https://github.com/home-assistant/operating-system/pull/768#discussion_r453337183) Co-authored-by: Franck Nijhof <frenck@frenck.nl> * Spelling correction, to ensure /Dpcumentation/kernel.mdhas the correct spelling * capitalisation * using - for unordered lists * Adding links to config files * fixing links to _defconfig files * fixing link for rpi0_w * fixing link for rpi3_64 and rpi4_64 * making the ova README consistent with the others * formmating * fixing numbered list * fixing indent for sub-bullets * questions regarding Tinker S and OVA support * resolving PR comment from fabaff * resolving PR comment from fabaff * https://github.com/home-assistant/operating-system/pull/769\#discussion_r456774209 * Changing uBoot to U-Boot (https://github.com/home-assistant/operating-system/pull/769#discussion_r456774290) * s/boot sector/eMMC boot partition/ (See https://github.com/home-assistant/operating-system/pull/769#discussion_r456774329) * As per comments here: https://github.com/home-assistant/operating-system/pull/769#discussion_r456791491 https://github.com/home-assistant/operating-system/pull/769#discussion_r456791580 * HassOS is no longer the official name (https://github.com/home-assistant/operating-system/pull/769#discussion_r456791863) * Should be Home Assistant Operating System (or OS) (see https://community.home-assistant.io/t/changing-the-home-assistant-brand/167500/16). See also commennts here https://github.com/home-assistant/operating-system/pull/769#discussion_r456793030, taken in to account along with previous comments about this paragraph. * s/HassOS/Home Assistant Operating System/ * 8Gb Pi 4 will be supported soon (see comment https://github.com/home-assistant/operating-system/pull/769#discussion_r459768349) * resolving conflict with main dev branch. Co-authored-by: Franck Nijhof <frenck@frenck.nl> Co-authored-by: Pascal Vizeli <pvizeli@syshack.ch>
This commit is contained in:
13
Documentation/README.md
Normal file
13
Documentation/README.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# Developer Documentation
|
||||
|
||||
## Contents
|
||||
|
||||
- [Getting started](./getting_started_development.md) - the place for developers to begin
|
||||
- [Development](./getting_started_development.md) - more deatils for developers
|
||||
- [Deployment](./deployment.md) - approach to git branching and releases
|
||||
- [Configuration](./configuration.md) - how users can configure HassOS
|
||||
- [Partition](./partition.md) - partition layout
|
||||
- [Network](./network.md) - approach to networking
|
||||
- [Bluetooth](./bluetooth.md) - approach to bluetooth
|
||||
- [Kernel](./kernel.md) - kernel versions
|
||||
- [Boards](./boards/README.md) - board specific documentation
|
||||
Reference in New Issue
Block a user