mirror of
https://github.com/tubearchivist/tubearchivist.git
synced 2024-10-13 09:17:16 +00:00
initial wiki pages
This commit is contained in:
parent
11067094b2
commit
ea2d0bcb6c
@ -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.
|
||||
|
1
docs/Channels.md
Normal file
1
docs/Channels.md
Normal file
@ -0,0 +1 @@
|
||||
# Channels Overview and Channel Detail Page
|
1
docs/Downloads.md
Normal file
1
docs/Downloads.md
Normal file
@ -0,0 +1 @@
|
||||
# Downloads Page Functionality
|
10
docs/Home.md
Normal file
10
docs/Home.md
Normal file
@ -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
|
1
docs/Main.md
Normal file
1
docs/Main.md
Normal file
@ -0,0 +1 @@
|
||||
# Tube Archivist Home Page Functionality
|
1
docs/Settings.md
Normal file
1
docs/Settings.md
Normal file
@ -0,0 +1 @@
|
||||
# Settings Page Functionality
|
Loading…
Reference in New Issue
Block a user