diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6b915756..9d79a4bb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,6 +8,14 @@ If you haven't already, the best place to start is the README. This will give yo If you notice something is not working as expected, check to see if it has been previously reported in the [open issues](https://github.com/bbilly1/tubearchivist/issues). If it has not yet been disclosed, go ahead and create an issue. +## Wiki + +WIP: The wiki is where all user functions are explained in detail. These pages are mirrored into the **docs** folder of the repo. This allows for pull requests and all other features like regular code. Make any changes there, and I'll sync them with the wiki tab. + +## Implementing a new feature + +Do you see anything on the roadmap that you would like to take a closer look at but you are not sure, what's the best way to tackle that? Or anything not on there yet you'd like to implement but are not sure how? Open up an issue and we try to find a solution together. + ## Making changes To fix a bug or implement a feature, fork the repository and make all changes to the testing branch. When ready, create a pull request. diff --git a/docs/Channels.md b/docs/Channels.md new file mode 100644 index 00000000..f4fb8a3d --- /dev/null +++ b/docs/Channels.md @@ -0,0 +1 @@ +# Channels Overview and Channel Detail Page diff --git a/docs/Downloads.md b/docs/Downloads.md new file mode 100644 index 00000000..d3c1092d --- /dev/null +++ b/docs/Downloads.md @@ -0,0 +1 @@ +# Downloads Page Functionality \ No newline at end of file diff --git a/docs/Home.md b/docs/Home.md new file mode 100644 index 00000000..6d22508c --- /dev/null +++ b/docs/Home.md @@ -0,0 +1,10 @@ +# Tube Archivist Wiki +*Documentation of user functionality* + +**WIP**: This is work in progress! + +Table of contents: +* [Main](Main): Tube Archivist landing page +* [Channels](Channels): Browse your channels, handle subscriptions +* [Downloads](Downloads): Scanning subscriptions, handle download queue +* [Settings](Settings): All the configuration options diff --git a/docs/Main.md b/docs/Main.md new file mode 100644 index 00000000..4c1d6dbc --- /dev/null +++ b/docs/Main.md @@ -0,0 +1 @@ +# Tube Archivist Home Page Functionality diff --git a/docs/Settings.md b/docs/Settings.md new file mode 100644 index 00000000..cd41c273 --- /dev/null +++ b/docs/Settings.md @@ -0,0 +1 @@ +# Settings Page Functionality \ No newline at end of file