From 6dce8ff61aa6c8e3609412d1924a9eb80b1d519c Mon Sep 17 00:00:00 2001 From: MM20 <15646950+MM2-0@users.noreply.github.com> Date: Sat, 10 Feb 2024 01:53:41 +0100 Subject: [PATCH] Docs: add edit link --- docs/.vitepress/config.mts | 3 +++ .../plugins/plugin-types/common/_plugin_state.md | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 28c654c1..023dafdc 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -28,6 +28,9 @@ export default defineConfig({ search: { provider: 'local', }, + editLink: { + pattern: 'https://github.com/MM2-0/Kvaesitso/edit/main/docs/:path', + }, }, head: [['link', { rel: 'icon', href: '/icon.png' }]], }) diff --git a/docs/docs/developer-guide/plugins/plugin-types/common/_plugin_state.md b/docs/docs/developer-guide/plugins/plugin-types/common/_plugin_state.md index 4c0812cd..f9c175d4 100644 --- a/docs/docs/developer-guide/plugins/plugin-types/common/_plugin_state.md +++ b/docs/docs/developer-guide/plugins/plugin-types/common/_plugin_state.md @@ -9,7 +9,7 @@ suspend fun getPluginState(): PluginState This method can either return `PluginState.Ready`, or `PluginState.SetupRequired`. - `PluginState.Ready` can have a status `text` to describe what the plugin does in its current configuration. For example _"Search {username}'s files on {service}_". This overrides the plugin's [description](/docs/developer-guide/plugins/metadata.html#description-1). -- `PluginState.SetupRequired` needs to a `setupActivity` Intent that starts the setup. You can also provide a `message` to describe what kind of setup needs to be performed. For example _"Sign in with {service} to search files on {service}"_ +- `PluginState.SetupRequired` needs to have a `setupActivity` Intent that starts the setup. You can also provide a `message` to describe what kind of setup needs to be performed. For example _"Sign in with {service} to search files on {service}"_ > [!IMPORTANT] > This method is only meant to provide hints to the launcher's user interface. You should not rely on it as a safeguard for your other plugin methods. There is still a chance that your other plugin methods are called regardless of the return value of this method. Make sure to check your requirements in the other plugin methods as well.