docs: Add example for auto-reloading css

[FjedorGaede]

While migrating to the v2 I noticed that the example from the original documentation on how to make auto-reloading of SCSS and CSS work was missing in the documentation. As I rely on it heavily and think it increases the DX alot - especially for new users - , it should be added to the documentation. The example I provided is the one that is running on my machine and works as expected. WDYT?

• Fjedor

[danielwerg]

This project uses 4 spaces and doesn't use semicolons, we should keep styling consistent across entire project.

[FjedorGaede]

Yes, makes sense. Added the changes.

[danielwerg]

Honestly hot-reloading of both scss and typescript should be built-in ags. Interested to hear what @Aylur thinks.

For now I use fd .* -E @girs | entr -crz ags run until I find better but still simple tool. Normally I would use vite in frontend project.

[Aylur]

I'll probably write a roadmap at some point, because this is a feature I have in mind.
For ags run I'm thinking of a --watch flag, but I don't think its possible to do hot module reloading like on web frameworks, at least I have no clue how it could be done, so all it would do is just restart the gjs process.
However for stylesheets it is possible. I'm thinking of doing it through dbus so all consumers of Astal.Application can benefit from it.

[Aylur]

We can merge this in the meantime though after #95 is fixed

[danielwerg]

few suggestions

[danielwerg]

don't use template literals unless required (backticks)

[danielwerg]

const scss = `${SRC}/style.scss` 

SRC could be used

[FjedorGaede]

Is ${SRC} the new built-in equivalent of ${App.configDir} or is it just something the user has to set? Because I couldn't find this anywhere in the docs and thus just used ./.

[ys5g]

EDIT: As Aylur says below, it's AGS-dependent, so it shouldn't be used here.

AGS also defines a global SRC variable which will be replaced by the value of the --src flag. By default it will point to the directory of entryfile.

Source: Bundling projects(ags docs)

Since Astal is a library it lost App.configDir.
[...]
In cases where you still have to refer to the source dir, AGS defines a global SRC variable.

Source: release notes for ags v2
Also (kind of) relevant: setting up a project(ags docs)

[Aylur]

Astal docs should not use AGS features as it is meant to be independent. It is a library, there is no concept of a src directory, it's the responsibility of build tools to handle that. ./ is fine for the example, it should just have a note under it like the one here

[FjedorGaede]

@danielwerg Good points. I pushed the changes