Merge pull request #41 from Aylur/retire

add legacy warning banner
Aylur · Nov 13, 2024 · c863912 · c863912
2 parents ef5359a + b5f2a84
commit c863912
Show file tree

Hide file tree

Showing 32 changed files with 69 additions and 5 deletions.
diff --git a/src/content/docs/config/app.md b/src/content/docs/config/app.md
@@ -1,6 +1,8 @@
 ---
 title: App
 description: The Gtk.Application Instance
+banner:
+  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.
 ---
 
 This is the main `Gtk.Application` instance that is running.

diff --git a/src/content/docs/config/cli.md b/src/content/docs/config/cli.md
@@ -1,6 +1,8 @@
 ---
 title: CLI
 description: Command Line Interface and running files
+banner:
+  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.
 ---
 
 ```sh

diff --git a/src/content/docs/config/common-issues.md b/src/content/docs/config/common-issues.md
@@ -1,6 +1,8 @@
 ---
 title: Common Issues
 description: Common Issues and Tips & Tricks
+banner:
+  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.
 ---
 
 ## Window doesn't show up
@@ -37,9 +39,11 @@ Widget.Icon({
 ```
 
 ## GtkWindow is not a layer surface
+
 If `Widget.Window` shows as up as a regular window,
 it usually means ags is running in xwayland.
 Try running `ags` from a non xwayland terminal, or try
+
 ```bash
 env GDK_BACKEND=wayland ags
 ```
diff --git a/src/content/docs/config/config-object.md b/src/content/docs/config/config-object.md
@@ -1,6 +1,8 @@
 ---
 title: Config Object
 description: Exported configuration object
+banner:
+  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.
 ---
 
 `App.config` can be called any number of times, the passed

diff --git a/src/content/docs/config/custom-service.md b/src/content/docs/config/custom-service.md
@@ -1,6 +1,8 @@
 ---
 title: Custom Service
 description: Writing Custom Services
+banner:
+  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.
 ---
 
 Writing a custom Service is as simple as
@@ -101,14 +103,13 @@ export default service;
 ```
 
 :::caution
-`Utils.monitorFile` only reports events that a user-space program 
+`Utils.monitorFile` only reports events that a user-space program
 triggers through the filesystem API. As a result, it does not catch
 remote events that occur on network filesystems.
 Furthermore, most pseudo-filesystems such as `/proc`, `/sys` and `/dev/pts`
 cannot be monitored.
 :::
 
-
 :::note
 For `bind` to work, the property has to be defined in `Service.register`
 :::

diff --git a/src/content/docs/config/examples.md b/src/content/docs/config/examples.md
@@ -1,5 +1,7 @@
 ---
 title: Examples
+banner:
+  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.
 ---
 
 :::note

diff --git a/src/content/docs/config/first-widgets.md b/src/content/docs/config/first-widgets.md
@@ -1,6 +1,8 @@
 ---
 title: Your First Widget
 description: Starting point to understanding how AGS works
+banner:
+  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.
 ---
 
 Start by creating `~/.config/ags/config.js`

diff --git a/src/content/docs/config/home-manager.md b/src/content/docs/config/home-manager.md
@@ -1,6 +1,8 @@
 ---
 title: Home Manager
 description: Home Manager Module
+banner:
+  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.
 ---
 
 Example content of a `flake.nix` file

diff --git a/src/content/docs/config/installation.md b/src/content/docs/config/installation.md
@@ -1,6 +1,8 @@
 ---
 title: Installation
 description: How to install AGS
+banner:
+  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.
 ---
 
 ## Nix

diff --git a/src/content/docs/config/javascript.md b/src/content/docs/config/javascript.md
@@ -1,6 +1,8 @@
 ---
 title: JavaScript
 description: 5 minute crash course for JavaScript
+banner:
+  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.
 ---
 
 If you don't know any JavaScript, this is a quick 5 minute course explaining most things you will need to understand.

diff --git a/src/content/docs/config/reactivity.md b/src/content/docs/config/reactivity.md
@@ -1,5 +1,7 @@
 ---
 title: Reactivity
+banner:
+  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.
 ---
 
 In order for widgets to have dynamic content we pass `Binding`s as properties

diff --git a/src/content/docs/config/services.md b/src/content/docs/config/services.md
@@ -1,6 +1,8 @@
 ---
 title: Services
 description: Builtin services to query system information
+banner:
+  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.
 ---
 
 A Service is an instance of a [GObject.Object](https://gjs-docs.gnome.org/gobject20~2.0/gobject.object)

diff --git a/src/content/docs/config/subclassing-gtk-widgets.md b/src/content/docs/config/subclassing-gtk-widgets.md
@@ -1,6 +1,8 @@
 ---
 title: Subclassing GTK Widgets
 description: Using GTK widgets not builtin
+banner:
+  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.
 ---
 
 ## Using Gtk.Widgets not builtin

diff --git a/src/content/docs/config/theming.md b/src/content/docs/config/theming.md
@@ -1,6 +1,8 @@
 ---
 title: Theming
 description: GTK3 CSS theming
+banner:
+  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.
 ---
 
 Since the widget toolkit is **GTK3** theming is done with **CSS**.

diff --git a/src/content/docs/config/type-checking.md b/src/content/docs/config/type-checking.md
@@ -1,5 +1,7 @@
 ---
 title: Type Checking
+banner:
+  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.
 ---
 
 To have auto suggestions and type checking while working on the configuration,

diff --git a/src/content/docs/config/utils.md b/src/content/docs/config/utils.md
@@ -1,6 +1,8 @@
 ---
 title: Utils
 description: Utility functions
+banner:
+  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.
 ---
 
 ## Running external commands
@@ -132,7 +134,7 @@ const monitor = Utils.monitorFile('/path/to/file', (file, event) => {
 ```
 
 :::caution
-`monitorFile` only reports events that a user-space program 
+`monitorFile` only reports events that a user-space program
 triggers through the filesystem API. As a result, it does not catch
 remote events that occur on network filesystems.
 Furthermore, most pseudo-filesystems such as `/proc`, `/sys` and `/dev/pts`

diff --git a/src/content/docs/config/variables.md b/src/content/docs/config/variables.md
@@ -1,6 +1,8 @@
 ---
 title: Variables
 description: Reactive variables
+banner:
+  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.
 ---
 
 Variable is just a simple `GObject` that holds a value.

diff --git a/src/content/docs/config/widgets.md b/src/content/docs/config/widgets.md
@@ -1,6 +1,8 @@
 ---
 title: Widgets
 description: List of builtin subclassed widgets
+banner:
+  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.
 ---
 
 `Widget` functions return an instance of [Gtk.Widget](https://gjs-docs.gnome.org/gtk30~3.0/gtk.widget).

diff --git a/src/content/docs/index.mdx b/src/content/docs/index.mdx
@@ -13,7 +13,7 @@ hero:
       link: https://github.com/Aylur/ags
       icon: github
 banner:
-  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.
+  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.
 ---
 
 import { Card, CardGrid } from '@astrojs/starlight/components';

diff --git a/src/content/docs/services/applications.md b/src/content/docs/services/applications.md
@@ -1,5 +1,7 @@
 ---
 title: Applications
+banner:
+  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.
 ---
 
 ## signals

diff --git a/src/content/docs/services/audio.md b/src/content/docs/services/audio.md
@@ -1,5 +1,7 @@
 ---
 title: Audio
+banner:
+  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.
 ---
 
 :::note

diff --git a/src/content/docs/services/backlight.md b/src/content/docs/services/backlight.md
@@ -1,5 +1,7 @@
 ---
 title: Backlight
+banner:
+  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.
 ---
 
 There is no builtin Backlight service, but you can find an [example service implementation](../../config/custom-service) using `brightnessctl`.
diff --git a/src/content/docs/services/battery.md b/src/content/docs/services/battery.md
@@ -1,5 +1,7 @@
 ---
 title: Battery
+banner:
+  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.
 ---
 
 :::note

diff --git a/src/content/docs/services/bluetooth.md b/src/content/docs/services/bluetooth.md
@@ -1,5 +1,7 @@
 ---
 title: Bluetooth
+banner:
+  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.
 ---
 
 :::note

diff --git a/src/content/docs/services/greetd.md b/src/content/docs/services/greetd.md
@@ -1,6 +1,8 @@
 ---
 title: Greetd
 description: Login Manager
+banner:
+  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.
 ---
 
 Look up how to enable and configure greetd for your distro.

diff --git a/src/content/docs/services/hyprland.md b/src/content/docs/services/hyprland.md
@@ -1,5 +1,7 @@
 ---
 title: Hyprland
+banner:
+  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.
 ---
 
 ## signals

diff --git a/src/content/docs/services/mpris.md b/src/content/docs/services/mpris.md
@@ -1,5 +1,7 @@
 ---
 title: Mpris
+banner:
+  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.
 ---
 
 :::note
@@ -8,7 +10,7 @@ NixOS: `services.gvfs`
 :::
 
 :::note
-Not every media player supports `position`, `volume` and other functionality. Support varies from player to player. 
+Not every media player supports `position`, `volume` and other functionality. Support varies from player to player.
 :::
 
 ## signals

diff --git a/src/content/docs/services/network.md b/src/content/docs/services/network.md
@@ -1,5 +1,7 @@
 ---
 title: Network
+banner:
+  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.
 ---
 
 :::note

diff --git a/src/content/docs/services/notifications.md b/src/content/docs/services/notifications.md
@@ -1,5 +1,7 @@
 ---
 title: Notifications
+banner:
+  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.
 ---
 
 ## signals

diff --git a/src/content/docs/services/powerprofiles.md b/src/content/docs/services/powerprofiles.md
@@ -1,5 +1,7 @@
 ---
 title: Power Profiles
+banner:
+  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.
 ---
 
 :::note

diff --git a/src/content/docs/services/systemtray.md b/src/content/docs/services/systemtray.md
@@ -1,5 +1,7 @@
 ---
 title: System Tray
+banner:
+  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.
 ---
 
 :::note

diff --git a/src/styles/custom.css b/src/styles/custom.css
@@ -11,6 +11,9 @@
     --sl-color-gray-5: #383838;
     --sl-color-gray-6: #272727;
     --sl-color-black: #171718;
+
+
+    --sl-color-banner-bg: #f66151;
 }
 
 /* Light mode colors. */