From d6697a612e6385b041b3ae33cfddd03e45622faf Mon Sep 17 00:00:00 2001 From: outfoxxed Date: Sat, 26 Jul 2025 22:01:51 -0700 Subject: [PATCH] fix broken /docs links in guides --- src/guide/v0_1_0/faq.md | 6 +++--- src/guide/v0_1_0/index.md | 10 +++++----- src/guide/v0_1_0/install-setup.md | 5 +++-- src/guide/v0_1_0/qml-language.md | 2 +- 4 files changed, 12 insertions(+), 11 deletions(-) diff --git a/src/guide/v0_1_0/faq.md b/src/guide/v0_1_0/faq.md index 0318655..0f14112 100644 --- a/src/guide/v0_1_0/faq.md +++ b/src/guide/v0_1_0/faq.md @@ -7,8 +7,8 @@ index: 1000 > [!NOTE] > This page is being actively expanded upon as more common questions come up. > -> Make sure to also read the [Item Size and Position](/docs/guide/size-position) and -> [QML Language](/docs/guide/qml-language) pages for questions related to +> Make sure to also read the [Item Size and Position](@docs/guide/size-position) and +> [QML Language](@docs/guide/qml-language) pages for questions related to > item sizing/positioning and QML in general. ## Misc @@ -100,7 +100,7 @@ its contained item. } ``` -[MarginWrapper]: /docs/guide/size-position#marginwrapper-components +[MarginWrapper]: @docs/guide/size-position#marginwrapper-components ### Reference images and resources By default, paths passed to components such as @@QtQuick.Image or diff --git a/src/guide/v0_1_0/index.md b/src/guide/v0_1_0/index.md index afcf8b8..748e60d 100644 --- a/src/guide/v0_1_0/index.md +++ b/src/guide/v0_1_0/index.md @@ -3,13 +3,13 @@ title: "Usage Guide" description: "Configuring the shell" index: -1 --- -See the [Installation and Setup](/docs/guide/install-setup) page to get started. +See the [Installation and Setup](@docs/guide/install-setup) page to get started. To write a Quickshell config, start by following the -[Guided Introduction](/docs/guide/introduction), and skimming the -[QML Language Overview](/docs/guide/qml-language). +[Guided Introduction](@docs/guide/introduction), and skimming the +[QML Language Overview](@docs/guide/qml-language). -After that, read the [Item Size and Position](/docs/guide/size-position) page before +After that, read the [Item Size and Position](@docs/guide/size-position) page before continuing on your own to learn how to lay out elements in QML. Laying out elements in QML is significantly different from many other layout systems such as CSS. @@ -24,7 +24,7 @@ considerably over time and most configs don't reflect current best practice. [Official Examples]: https://git.outfoxxed.me/quickshell/quickshell-examples -See also the [FAQ](/docs/guide/faq) page, and the [Matrix Space] or [Discord Server] (bridged) for help. +See also the [FAQ](@docs/guide/faq) page, and the [Matrix Space] or [Discord Server] (bridged) for help. [Matrix Space]: https://matrix.to/#/#quickshell:outfoxxed.me [Discord Server]: https://discord.gg/UtZeT3xNyT diff --git a/src/guide/v0_1_0/install-setup.md b/src/guide/v0_1_0/install-setup.md index 5a9635b..dcdc612 100644 --- a/src/guide/v0_1_0/install-setup.md +++ b/src/guide/v0_1_0/install-setup.md @@ -114,7 +114,7 @@ for build instructions and configurations. ## Editor configuration If you want to write your own configuration, installing a QML grammar and the LSP is recommended. -Read the [Usage Guide](/docs/guide) after configuring your editor. +Read the [Usage Guide](@docs/guide) after configuring your editor. > [!NOTE] > Qmlls versions prior to 6.8.2 do not require `-E` @@ -190,6 +190,7 @@ We are aware of the following issues: this problem and how to fix it. - The LSP cannot provide any documentation for Quickshell types. - `root:` imports cannot be resolved by the LSP. +- `PanelWindow` in particular cannot be resolved. Keeping in mind the above caveats, qmlls should be able to guide you towards a more correct code should you choose to use it. @@ -201,4 +202,4 @@ more correct code should you choose to use it. # Next steps -Create your first configuration by reading the [Intro](/docs/configuration/intro). +Create your first configuration by reading the [Intro](@docs/guide/introduction). diff --git a/src/guide/v0_1_0/qml-language.md b/src/guide/v0_1_0/qml-language.md index 943fbf1..47ff55d 100644 --- a/src/guide/v0_1_0/qml-language.md +++ b/src/guide/v0_1_0/qml-language.md @@ -173,7 +173,7 @@ Name { Every object can contain [properties](#properties), [functions](#functions), and [signals](#signals). You can find out what properties are available for a type -by looking it up in the [Type Reference](/docs/types/). +by looking it up in the [Type Reference](@docs/types/). #### Properties