Skip to content

Commit b5f2a84

Browse files
committed
add legacy warning banner
1 parent ef5359a commit b5f2a84

32 files changed

+69
-5
lines changed

src/content/docs/config/app.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: App
33
description: The Gtk.Application Instance
4+
banner:
5+
content: You are looking at the legacy documentation of AGS v1. Go to <a href="https://aylur.github.io/ags/">aylur.github.io/ags</a> for AGS v2.
46
---
57

68
This is the main `Gtk.Application` instance that is running.

src/content/docs/config/cli.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: CLI
33
description: Command Line Interface and running files
4+
banner:
5+
content: You are looking at the legacy documentation of AGS v1. Go to <a href="https://aylur.github.io/ags/">aylur.github.io/ags</a> for AGS v2.
46
---
57

68
```sh

src/content/docs/config/common-issues.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: Common Issues
33
description: Common Issues and Tips & Tricks
4+
banner:
5+
content: You are looking at the legacy documentation of AGS v1. Go to <a href="https://aylur.github.io/ags/">aylur.github.io/ags</a> for AGS v2.
46
---
57

68
## Window doesn't show up
@@ -37,9 +39,11 @@ Widget.Icon({
3739
```
3840

3941
## GtkWindow is not a layer surface
42+
4043
If `Widget.Window` shows as up as a regular window,
4144
it usually means ags is running in xwayland.
4245
Try running `ags` from a non xwayland terminal, or try
46+
4347
```bash
4448
env GDK_BACKEND=wayland ags
4549
```

src/content/docs/config/config-object.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: Config Object
33
description: Exported configuration object
4+
banner:
5+
content: You are looking at the legacy documentation of AGS v1. Go to <a href="https://aylur.github.io/ags/">aylur.github.io/ags</a> for AGS v2.
46
---
57

68
`App.config` can be called any number of times, the passed

src/content/docs/config/custom-service.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: Custom Service
33
description: Writing Custom Services
4+
banner:
5+
content: You are looking at the legacy documentation of AGS v1. Go to <a href="https://aylur.github.io/ags/">aylur.github.io/ags</a> for AGS v2.
46
---
57

68
Writing a custom Service is as simple as
@@ -101,14 +103,13 @@ export default service;
101103
```
102104

103105
:::caution
104-
`Utils.monitorFile` only reports events that a user-space program
106+
`Utils.monitorFile` only reports events that a user-space program
105107
triggers through the filesystem API. As a result, it does not catch
106108
remote events that occur on network filesystems.
107109
Furthermore, most pseudo-filesystems such as `/proc`, `/sys` and `/dev/pts`
108110
cannot be monitored.
109111
:::
110112

111-
112113
:::note
113114
For `bind` to work, the property has to be defined in `Service.register`
114115
:::

src/content/docs/config/examples.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
title: Examples
3+
banner:
4+
content: You are looking at the legacy documentation of AGS v1. Go to <a href="https://aylur.github.io/ags/">aylur.github.io/ags</a> for AGS v2.
35
---
46

57
:::note

src/content/docs/config/first-widgets.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: Your First Widget
33
description: Starting point to understanding how AGS works
4+
banner:
5+
content: You are looking at the legacy documentation of AGS v1. Go to <a href="https://aylur.github.io/ags/">aylur.github.io/ags</a> for AGS v2.
46
---
57

68
Start by creating `~/.config/ags/config.js`

src/content/docs/config/home-manager.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: Home Manager
33
description: Home Manager Module
4+
banner:
5+
content: You are looking at the legacy documentation of AGS v1. Go to <a href="https://aylur.github.io/ags/">aylur.github.io/ags</a> for AGS v2.
46
---
57

68
Example content of a `flake.nix` file

src/content/docs/config/installation.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: Installation
33
description: How to install AGS
4+
banner:
5+
content: You are looking at the legacy documentation of AGS v1. Go to <a href="https://aylur.github.io/ags/">aylur.github.io/ags</a> for AGS v2.
46
---
57

68
## Nix

src/content/docs/config/javascript.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: JavaScript
33
description: 5 minute crash course for JavaScript
4+
banner:
5+
content: You are looking at the legacy documentation of AGS v1. Go to <a href="https://aylur.github.io/ags/">aylur.github.io/ags</a> for AGS v2.
46
---
57

68
If you don't know any JavaScript, this is a quick 5 minute course explaining most things you will need to understand.

src/content/docs/config/reactivity.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
title: Reactivity
3+
banner:
4+
content: You are looking at the legacy documentation of AGS v1. Go to <a href="https://aylur.github.io/ags/">aylur.github.io/ags</a> for AGS v2.
35
---
46

57
In order for widgets to have dynamic content we pass `Binding`s as properties

src/content/docs/config/services.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: Services
33
description: Builtin services to query system information
4+
banner:
5+
content: You are looking at the legacy documentation of AGS v1. Go to <a href="https://aylur.github.io/ags/">aylur.github.io/ags</a> for AGS v2.
46
---
57

68
A Service is an instance of a [GObject.Object](https://gjs-docs.gnome.org/gobject20~2.0/gobject.object)

src/content/docs/config/subclassing-gtk-widgets.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: Subclassing GTK Widgets
33
description: Using GTK widgets not builtin
4+
banner:
5+
content: You are looking at the legacy documentation of AGS v1. Go to <a href="https://aylur.github.io/ags/">aylur.github.io/ags</a> for AGS v2.
46
---
57

68
## Using Gtk.Widgets not builtin

src/content/docs/config/theming.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: Theming
33
description: GTK3 CSS theming
4+
banner:
5+
content: You are looking at the legacy documentation of AGS v1. Go to <a href="https://aylur.github.io/ags/">aylur.github.io/ags</a> for AGS v2.
46
---
57

68
Since the widget toolkit is **GTK3** theming is done with **CSS**.

src/content/docs/config/type-checking.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
title: Type Checking
3+
banner:
4+
content: You are looking at the legacy documentation of AGS v1. Go to <a href="https://aylur.github.io/ags/">aylur.github.io/ags</a> for AGS v2.
35
---
46

57
To have auto suggestions and type checking while working on the configuration,

src/content/docs/config/utils.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: Utils
33
description: Utility functions
4+
banner:
5+
content: You are looking at the legacy documentation of AGS v1. Go to <a href="https://aylur.github.io/ags/">aylur.github.io/ags</a> for AGS v2.
46
---
57

68
## Running external commands
@@ -132,7 +134,7 @@ const monitor = Utils.monitorFile('/path/to/file', (file, event) => {
132134
```
133135

134136
:::caution
135-
`monitorFile` only reports events that a user-space program
137+
`monitorFile` only reports events that a user-space program
136138
triggers through the filesystem API. As a result, it does not catch
137139
remote events that occur on network filesystems.
138140
Furthermore, most pseudo-filesystems such as `/proc`, `/sys` and `/dev/pts`

src/content/docs/config/variables.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: Variables
33
description: Reactive variables
4+
banner:
5+
content: You are looking at the legacy documentation of AGS v1. Go to <a href="https://aylur.github.io/ags/">aylur.github.io/ags</a> for AGS v2.
46
---
57

68
Variable is just a simple `GObject` that holds a value.

src/content/docs/config/widgets.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: Widgets
33
description: List of builtin subclassed widgets
4+
banner:
5+
content: You are looking at the legacy documentation of AGS v1. Go to <a href="https://aylur.github.io/ags/">aylur.github.io/ags</a> for AGS v2.
46
---
57

68
`Widget` functions return an instance of [Gtk.Widget](https://gjs-docs.gnome.org/gtk30~3.0/gtk.widget).

src/content/docs/index.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ hero:
1313
link: https://github.com/Aylur/ags
1414
icon: github
1515
banner:
16-
content: 🚀 <a href="https://github.com/Aylur/ags/pull/504">AGS v2</a> is soon to be merged, consider checking it before jumping into this documentation if you are starting out.
16+
content: You are looking at the legacy documentation of AGS v1. Go to <a href="https://aylur.github.io/ags/">aylur.github.io/ags</a> for AGS v2.
1717
---
1818

1919
import { Card, CardGrid } from '@astrojs/starlight/components';

src/content/docs/services/applications.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
title: Applications
3+
banner:
4+
content: You are looking at the legacy documentation of AGS v1. Go to <a href="https://aylur.github.io/ags/">aylur.github.io/ags</a> for AGS v2.
35
---
46

57
## signals

src/content/docs/services/audio.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
title: Audio
3+
banner:
4+
content: You are looking at the legacy documentation of AGS v1. Go to <a href="https://aylur.github.io/ags/">aylur.github.io/ags</a> for AGS v2.
35
---
46

57
:::note
+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
title: Backlight
3+
banner:
4+
content: You are looking at the legacy documentation of AGS v1. Go to <a href="https://aylur.github.io/ags/">aylur.github.io/ags</a> for AGS v2.
35
---
46

57
There is no builtin Backlight service, but you can find an [example service implementation](../../config/custom-service) using `brightnessctl`.

src/content/docs/services/battery.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
title: Battery
3+
banner:
4+
content: You are looking at the legacy documentation of AGS v1. Go to <a href="https://aylur.github.io/ags/">aylur.github.io/ags</a> for AGS v2.
35
---
46

57
:::note

src/content/docs/services/bluetooth.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
title: Bluetooth
3+
banner:
4+
content: You are looking at the legacy documentation of AGS v1. Go to <a href="https://aylur.github.io/ags/">aylur.github.io/ags</a> for AGS v2.
35
---
46

57
:::note

src/content/docs/services/greetd.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: Greetd
33
description: Login Manager
4+
banner:
5+
content: You are looking at the legacy documentation of AGS v1. Go to <a href="https://aylur.github.io/ags/">aylur.github.io/ags</a> for AGS v2.
46
---
57

68
Look up how to enable and configure greetd for your distro.

src/content/docs/services/hyprland.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
title: Hyprland
3+
banner:
4+
content: You are looking at the legacy documentation of AGS v1. Go to <a href="https://aylur.github.io/ags/">aylur.github.io/ags</a> for AGS v2.
35
---
46

57
## signals

src/content/docs/services/mpris.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
title: Mpris
3+
banner:
4+
content: You are looking at the legacy documentation of AGS v1. Go to <a href="https://aylur.github.io/ags/">aylur.github.io/ags</a> for AGS v2.
35
---
46

57
:::note
@@ -8,7 +10,7 @@ NixOS: `services.gvfs`
810
:::
911

1012
:::note
11-
Not every media player supports `position`, `volume` and other functionality. Support varies from player to player.
13+
Not every media player supports `position`, `volume` and other functionality. Support varies from player to player.
1214
:::
1315

1416
## signals

src/content/docs/services/network.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
title: Network
3+
banner:
4+
content: You are looking at the legacy documentation of AGS v1. Go to <a href="https://aylur.github.io/ags/">aylur.github.io/ags</a> for AGS v2.
35
---
46

57
:::note

src/content/docs/services/notifications.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
title: Notifications
3+
banner:
4+
content: You are looking at the legacy documentation of AGS v1. Go to <a href="https://aylur.github.io/ags/">aylur.github.io/ags</a> for AGS v2.
35
---
46

57
## signals

src/content/docs/services/powerprofiles.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
title: Power Profiles
3+
banner:
4+
content: You are looking at the legacy documentation of AGS v1. Go to <a href="https://aylur.github.io/ags/">aylur.github.io/ags</a> for AGS v2.
35
---
46

57
:::note

src/content/docs/services/systemtray.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
title: System Tray
3+
banner:
4+
content: You are looking at the legacy documentation of AGS v1. Go to <a href="https://aylur.github.io/ags/">aylur.github.io/ags</a> for AGS v2.
35
---
46

57
:::note

src/styles/custom.css

+3
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@
1111
--sl-color-gray-5: #383838;
1212
--sl-color-gray-6: #272727;
1313
--sl-color-black: #171718;
14+
15+
16+
--sl-color-banner-bg: #f66151;
1417
}
1518

1619
/* Light mode colors. */

0 commit comments

Comments
 (0)