From e038da433f219c496bb14a7393fe4ecebdd2eff4 Mon Sep 17 00:00:00 2001 From: UncleRoger33 <66418211+UncleRoger33@users.noreply.github.com> Date: Thu, 30 Dec 2021 02:46:49 +0300 Subject: [PATCH] Fix broken and outdated links in the Help document (#2180) * Update Contributing.md Fixed readme.md link. * Update Introduction.md "/settings?tab=configuration" is no longer valid. It is "/settings?tab=libraries" now. * Update Interface.md Fixed broken "Stash Plex Theme" link. * Update ScraperDevelopment.md Fixed broken "golang fields" link. * Update Interactive.md Added missing title. * Update Contributing.md Changed link to the correct document --> https://github.com/stashapp/stash/pull/2180/files/4c71a7dc1ba09cba5c6d527b8b500c198c08772d#r776229444 --- ui/v2.5/src/docs/en/Contributing.md | 4 ++-- ui/v2.5/src/docs/en/Interactive.md | 2 ++ ui/v2.5/src/docs/en/Interface.md | 4 ++-- ui/v2.5/src/docs/en/Introduction.md | 4 ++-- ui/v2.5/src/docs/en/ScraperDevelopment.md | 4 ++-- 5 files changed, 10 insertions(+), 8 deletions(-) diff --git a/ui/v2.5/src/docs/en/Contributing.md b/ui/v2.5/src/docs/en/Contributing.md index c59092105..885253a0c 100644 --- a/ui/v2.5/src/docs/en/Contributing.md +++ b/ui/v2.5/src/docs/en/Contributing.md @@ -6,7 +6,7 @@ Financial contributions are welcomed and are accepted using [Open Collective](ht ## Development-related -The Stash backend is written in golang with a sqlite database. The UI is written in react. Bug fixes, improvements and new features are welcomed. Please see the [README.md](https://github.com/stashapp/stash/raw/develop/README.md) file for details on how to get started. Assistance can be provided via our [Discord](https://discord.gg/2TsNFKt). +The Stash backend is written in golang with a sqlite database. The UI is written in react. Bug fixes, improvements and new features are welcomed. Please see the [README.md](https://github.com/stashapp/stash/blob/develop/docs/DEVELOPMENT.md) file for details on how to get started. Assistance can be provided via our [Discord](https://discord.gg/2TsNFKt). ## Documentation @@ -44,4 +44,4 @@ We welcome contributions for future improvements and features, and bug reports h ## Providing support -Offering support for new users on [Discord](https://discord.gg/2TsNFKt) is also welcomed. \ No newline at end of file +Offering support for new users on [Discord](https://discord.gg/2TsNFKt) is also welcomed. diff --git a/ui/v2.5/src/docs/en/Interactive.md b/ui/v2.5/src/docs/en/Interactive.md index 53c4bd45e..831109aab 100644 --- a/ui/v2.5/src/docs/en/Interactive.md +++ b/ui/v2.5/src/docs/en/Interactive.md @@ -1,3 +1,5 @@ +# Interactivity + Stash currently supports syncing with Handy devices, using funscript files. In order for stash to connect to your Handy device, the Handy Connection Key must be entered in Settings -> Interface. diff --git a/ui/v2.5/src/docs/en/Interface.md b/ui/v2.5/src/docs/en/Interface.md index 9307cd6a1..7bfe1722e 100644 --- a/ui/v2.5/src/docs/en/Interface.md +++ b/ui/v2.5/src/docs/en/Interface.md @@ -24,7 +24,7 @@ The maximum loop duration option allows looping of shorter videos. Set this valu The stash UI can be customised using custom CSS. See [here](https://github.com/stashapp/stash/wiki/Custom-CSS-snippets) for a community-curated set of CSS snippets to customise your UI. -[Stash Plex Theme](https://github.com/stashapp/stash/wiki/Stash-Plex-Theme) is a community created theme inspired by the popular Plex interface. +[Stash Plex Theme](https://github.com/stashapp/stash/wiki/Theme-Plex) is a community created theme inspired by the popular Plex interface. ## Custom served folders @@ -50,4 +50,4 @@ custom_served_folders: The `background.png` and `noise.png` files can be placed in the `custom` folder, then in the custom css, the `./background.png` and `./noise.png` strings can be replaced with `/custom/background.png` and `/custom/noise.png` respectively. -Other applications are to add custom UIs to stash, accessible via `/custom`. \ No newline at end of file +Other applications are to add custom UIs to stash, accessible via `/custom`. diff --git a/ui/v2.5/src/docs/en/Introduction.md b/ui/v2.5/src/docs/en/Introduction.md index e40f6c880..92c07a834 100644 --- a/ui/v2.5/src/docs/en/Introduction.md +++ b/ui/v2.5/src/docs/en/Introduction.md @@ -1,7 +1,7 @@ # Introduction -Stash works by cataloging your media using the paths that you provide. Once you have [configured](/settings?tab=configuration) the locations where your media is stored, you can click the Scan button in [`Settings -> Tasks`](/settings?tab=tasks) and stash will begin scanning and importing your media into its library. +Stash works by cataloging your media using the paths that you provide. Once you have [configured](/settings?tab=library) the locations where your media is stored, you can click the Scan button in [`Settings -> Tasks`](/settings?tab=tasks) and stash will begin scanning and importing your media into its library. For the best experience, it is recommmended that after a scan is finished, that video previews and sprites are generated. You can do this in [`Settings -> Tasks`](/settings?tab=tasks). Note that currently it is only possible to perform one task at a time and there is no task queue, so the Generate task should be performed after Scan is complete. -Once your media is imported, you are ready to begin creating Performers, Studios and Tags, and curating your content! \ No newline at end of file +Once your media is imported, you are ready to begin creating Performers, Studios and Tags, and curating your content! diff --git a/ui/v2.5/src/docs/en/ScraperDevelopment.md b/ui/v2.5/src/docs/en/ScraperDevelopment.md index a382fe2a0..f1f802d86 100644 --- a/ui/v2.5/src/docs/en/ScraperDevelopment.md +++ b/ui/v2.5/src/docs/en/ScraperDevelopment.md @@ -273,7 +273,7 @@ Collectively, these configurations are known as mapped scraping configurations. A mapped scraping configuration may contain a `common` field, and must contain `performer`, `scene`, `movie` or `gallery` depending on the scraping type it is configured for. -Within the `performer`/`scene`/`movie`/`gallery` field are key/value pairs corresponding to the [golang fields](#object-fields) on the performer/scene object. These fields are case-sensitive. +Within the `performer`/`scene`/`movie`/`gallery` field are key/value pairs corresponding to the [golang fields](/help/ScraperDevelopment.md#object-fields) on the performer/scene object. These fields are case-sensitive. The values of these may be either a simple selector value, which tells the system where to get the value of the field from, or a more advanced configuration (see below). For example, for an xpath configuration: @@ -822,4 +822,4 @@ Rating Studio (see Studio Fields) Tags (see Tag fields) Performers (list of Performer fields) -``` \ No newline at end of file +```