diff --git a/docs/Writerside/cfg/buildprofiles.xml b/docs/Writerside/cfg/buildprofiles.xml new file mode 100644 index 0000000..af67651 --- /dev/null +++ b/docs/Writerside/cfg/buildprofiles.xml @@ -0,0 +1,12 @@ + + + + + + + true + + + + diff --git a/docs/Writerside/images/knight-crawler-logo.png b/docs/Writerside/images/knight-crawler-logo.png new file mode 100644 index 0000000..1f87a43 Binary files /dev/null and b/docs/Writerside/images/knight-crawler-logo.png differ diff --git a/docs/Writerside/kc.tree b/docs/Writerside/kc.tree new file mode 100644 index 0000000..f1201aa --- /dev/null +++ b/docs/Writerside/kc.tree @@ -0,0 +1,12 @@ + + + + + + + + + + \ No newline at end of file diff --git a/docs/Writerside/topics/How-to.md b/docs/Writerside/topics/How-to.md new file mode 100644 index 0000000..04236f6 --- /dev/null +++ b/docs/Writerside/topics/How-to.md @@ -0,0 +1,37 @@ +# How to + +A How-to article is an action-oriented type of document. +It explains how to perform a specific task or solve a problem, and usually contains a sequence of steps. +Start with a short introductory paragraph that explains what users will accomplish by following this procedure, +what they need to perform it for, or define the target audience of the doc. + +> **Highlight important information** +> +> You can change the element to *tip* or *warning* by renaming the style attribute below. +> +{style="note"} + +## Before you start + +It is good practice to list the prerequisites that are required or recommended. + +Make sure that: +- First prerequisite +- Second prerequisite + +## How to perform a task + +Some introductory information. + +1. Step with a code block + + ```bash + run this --that + ``` + +2. Step with a [link](https://www.jetbrains.com) + +3. Step with a list. + - List item + - List item + - List item \ No newline at end of file diff --git a/docs/Writerside/topics/Overview.md b/docs/Writerside/topics/Overview.md new file mode 100644 index 0000000..9d08b40 --- /dev/null +++ b/docs/Writerside/topics/Overview.md @@ -0,0 +1,25 @@ +# Overview + +The image shows a Knight in silvery armour looking forwards. + +Knight Crawler is a self-hosted [Stremio](https://www.stremio.com/) addon for streaming torrents via a [Debrid](Supported-Debrid-services.md "Click for a list of Debrid services we support") service. + +We are active on [Discord](https://discord.gg/8fQdxay9z2) for both support and casual conversation. + +> Knight Crawler is currently alpha software. +> +> Users are responsible for ensuring their data is backed up regularly. +> +> Please read the changelogs before updating to the latest version. +> +{style="warning"} + +## What does Knight Crawler do? + +Knight Crawler is an addon for [Stremio](https://www.stremio.com/). It began as a fork of the very popular [Torrentio](https://github.com/TheBeastLT/torrentio-scraper) addon. Knight crawler essentially does the following: + +1. It searches the internet for available films and tv shows. +2. It collects as much information as it can about each film and tv show it finds. +3. It then stores this information to a database for easy access. + +When you choose on a film or tv show to watch on Stremio, a request will be sent to your installation of Knight Crawler. Knight Crawler will query the database and return a list of all the copies it has stored in the database as Debrid links. This enables playback to begin immediately for your chosen media. \ No newline at end of file diff --git a/docs/Writerside/topics/Supported-Debrid-services.md b/docs/Writerside/topics/Supported-Debrid-services.md new file mode 100644 index 0000000..b00eb7c --- /dev/null +++ b/docs/Writerside/topics/Supported-Debrid-services.md @@ -0,0 +1,3 @@ +# Supported Debrid services + +Start typing here... \ No newline at end of file diff --git a/docs/Writerside/writerside.cfg b/docs/Writerside/writerside.cfg new file mode 100644 index 0000000..86ad31a --- /dev/null +++ b/docs/Writerside/writerside.cfg @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file