Move documentation from README to wiki - Githubissues

Grimcheese / GardenStation

All in one solution for monitoring my garden.

0 stars 0 forks source link

Move documentation from README to wiki #3

Closed Grimcheese closed 9 months ago

Grimcheese commented 9 months ago

The README file contains a lot of extra documentation that should be placed in the wiki. The README should be a description of how to use the program, not every detail about its implementation.

Set up headings in README:

GardenStation (Basic introduction, aims, functions)
Functionality
Requirements
Getting setup
Troubleshooting

The wiki will be expanded over time but some pages to get started could include:

GardenStation Design
Roadmap/Goals
Technical Specifications
Hardware
Application Security Overview
Intall/Run Guide (From the README)

Grimcheese commented 9 months ago

Wiki syncing with docs directory using Github actions is working so this issue can be worked on now.