Skip to content

Commit d6697a6

Browse files
committed
fix broken /docs links in guides
1 parent f3dafd1 commit d6697a6

File tree

4 files changed

+12
-11
lines changed

4 files changed

+12
-11
lines changed

src/guide/v0_1_0/faq.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ index: 1000
77
> [!NOTE]
88
> This page is being actively expanded upon as more common questions come up.
99
>
10-
> Make sure to also read the [Item Size and Position](/docs/guide/size-position) and
11-
> [QML Language](/docs/guide/qml-language) pages for questions related to
10+
> Make sure to also read the [Item Size and Position](@docs/guide/size-position) and
11+
> [QML Language](@docs/guide/qml-language) pages for questions related to
1212
> item sizing/positioning and QML in general.
1313
1414
## Misc
@@ -100,7 +100,7 @@ its contained item.
100100
}
101101
```
102102

103-
[MarginWrapper]: /docs/guide/size-position#marginwrapper-components
103+
[MarginWrapper]: @docs/guide/size-position#marginwrapper-components
104104

105105
### Reference images and resources
106106
By default, paths passed to components such as @@QtQuick.Image or

src/guide/v0_1_0/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ title: "Usage Guide"
33
description: "Configuring the shell"
44
index: -1
55
---
6-
See the [Installation and Setup](/docs/guide/install-setup) page to get started.
6+
See the [Installation and Setup](@docs/guide/install-setup) page to get started.
77

88
To write a Quickshell config, start by following the
9-
[Guided Introduction](/docs/guide/introduction), and skimming the
10-
[QML Language Overview](/docs/guide/qml-language).
9+
[Guided Introduction](@docs/guide/introduction), and skimming the
10+
[QML Language Overview](@docs/guide/qml-language).
1111

12-
After that, read the [Item Size and Position](/docs/guide/size-position) page before
12+
After that, read the [Item Size and Position](@docs/guide/size-position) page before
1313
continuing on your own to learn how to lay out elements in QML. Laying out elements
1414
in QML is significantly different from many other layout systems such as CSS.
1515

@@ -24,7 +24,7 @@ considerably over time and most configs don't reflect current best practice.
2424

2525
[Official Examples]: https://git.outfoxxed.me/quickshell/quickshell-examples
2626

27-
See also the [FAQ](/docs/guide/faq) page, and the [Matrix Space] or [Discord Server] (bridged) for help.
27+
See also the [FAQ](@docs/guide/faq) page, and the [Matrix Space] or [Discord Server] (bridged) for help.
2828

2929
[Matrix Space]: https://matrix.to/#/#quickshell:outfoxxed.me
3030
[Discord Server]: https://discord.gg/UtZeT3xNyT

src/guide/v0_1_0/install-setup.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ for build instructions and configurations.
114114
## Editor configuration
115115
If you want to write your own configuration, installing a QML grammar and the LSP is recommended.
116116

117-
Read the [Usage Guide](/docs/guide) after configuring your editor.
117+
Read the [Usage Guide](@docs/guide) after configuring your editor.
118118

119119
> [!NOTE]
120120
> Qmlls versions prior to 6.8.2 do not require `-E`
@@ -190,6 +190,7 @@ We are aware of the following issues:
190190
this problem and how to fix it.
191191
- The LSP cannot provide any documentation for Quickshell types.
192192
- `root:` imports cannot be resolved by the LSP.
193+
- `PanelWindow` in particular cannot be resolved.
193194

194195
Keeping in mind the above caveats, qmlls should be able to guide you towards a
195196
more correct code should you choose to use it.
@@ -201,4 +202,4 @@ more correct code should you choose to use it.
201202
202203
# Next steps
203204

204-
Create your first configuration by reading the [Intro](/docs/configuration/intro).
205+
Create your first configuration by reading the [Intro](@docs/guide/introduction).

src/guide/v0_1_0/qml-language.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ Name {
173173

174174
Every object can contain [properties](#properties), [functions](#functions),
175175
and [signals](#signals). You can find out what properties are available for a type
176-
by looking it up in the [Type Reference](/docs/types/).
176+
by looking it up in the [Type Reference](@docs/types/).
177177

178178
#### Properties
179179

0 commit comments

Comments
 (0)