quickshell/quickshell-web
3
1
Fork 0
Code Issues Projects Activity

fix broken /docs links in guides

Browse source
This commit is contained in:
outfoxxed 2025-07-26 22:01:51 -07:00
parent f3dafd1172
commit d6697a612e
Signed by: outfoxxed
GPG key ID: 4C88A185FB89301E
4 changed files with 12 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

6
src/guide/v0_1_0/faq.md
View file

@ -7,8 +7,8 @@ index: 1000
> [!NOTE] > [!NOTE]
> This page is being actively expanded upon as more common questions come up. > 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 > 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 > [QML Language](@docs/guide/qml-language) pages for questions related to
> item sizing/positioning and QML in general. > item sizing/positioning and QML in general.
## Misc ## 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 ### Reference images and resources
By default, paths passed to components such as @@QtQuick.Image or By default, paths passed to components such as @@QtQuick.Image or

10
src/guide/v0_1_0/index.md
View file

@ -3,13 +3,13 @@ title: "Usage Guide"
description: "Configuring the shell" description: "Configuring the shell"
index: -1 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 To write a Quickshell config, start by following the
[Guided Introduction](/docs/guide/introduction), and skimming the [Guided Introduction](@docs/guide/introduction), and skimming the
[QML Language Overview](/docs/guide/qml-language). [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 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. 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 [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 [Matrix Space]: https://matrix.to/#/#quickshell:outfoxxed.me
[Discord Server]: https://discord.gg/UtZeT3xNyT [Discord Server]: https://discord.gg/UtZeT3xNyT

5
src/guide/v0_1_0/install-setup.md
View file

@ -114,7 +114,7 @@ for build instructions and configurations.
## Editor configuration ## Editor configuration
If you want to write your own configuration, installing a QML grammar and the LSP is recommended. 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] > [!NOTE]
> Qmlls versions prior to 6.8.2 do not require `-E` > 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. this problem and how to fix it.
- The LSP cannot provide any documentation for Quickshell types. - The LSP cannot provide any documentation for Quickshell types.
- `root:` imports cannot be resolved by the LSP. - `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 Keeping in mind the above caveats, qmlls should be able to guide you towards a
more correct code should you choose to use it. more correct code should you choose to use it.
@ -201,4 +202,4 @@ more correct code should you choose to use it.
# Next steps # Next steps
Create your first configuration by reading the [Intro](/docs/configuration/intro). Create your first configuration by reading the [Intro](@docs/guide/introduction).

2
src/guide/v0_1_0/qml-language.md
View file

@ -173,7 +173,7 @@ Name {
Every object can contain [properties](#properties), [functions](#functions), Every object can contain [properties](#properties), [functions](#functions),
and [signals](#signals). You can find out what properties are available for a type 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 #### Properties