Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added a warning for installing sway #443

Closed
wants to merge 3 commits into from

Conversation

Ghodawalaaman
Copy link

No description provided.

@dbaio
Copy link
Member

dbaio commented Dec 28, 2024

Hi.

I don't think it's best to put the warning at the start of the section. Maybe it would fit better later on, where it seems more natural.

Also, there is already a link at the beginning of this chapter to 'How to Identify and Configure Drivers for Your Graphics Hardware' that might be useful.

@Ghodawalaaman
Copy link
Author

I didn't know about that chapter in the book, however it still makes sense to at least warn user before they install Sway and try to run it.

maybe we should point the user to that chapter saying "please read this section before installing sway"

@sergio-carlavilla
Copy link
Contributor

I didn't know about that chapter in the book, however it still makes sense to at least warn user before they install Sway and try to run it.

maybe we should point the user to that chapter saying "please read this section before installing sway"

Can you please change your patch to make this change?
I think it's a good idea :)

@Ghodawalaaman
Copy link
Author

I have changed the commit and now it points the user to section 'How to Identify and Configure Drivers for Your Graphics Hardware'.

I hope it will be useful for someone.

@dbaio
Copy link
Member

dbaio commented Jan 4, 2025

I suggest something like this to avoid a warning or note at the start of the section.

sway-gpu

`diff --git a/documentation/content/en/books/handbook/wayland/_index.adoc b/documentation/content/en/books/handbook/wayland/_index.adoc
index f82f0459d6..d6b5168e9f 100644
--- a/documentation/content/en/books/handbook/wayland/_index.adoc
+++ b/documentation/content/en/books/handbook/wayland/_index.adoc
@@ -372,6 +372,11 @@ To start Hikari, use the following command:

The Sway compositor is a tiling compositor that attempts to replace the i3 windows manager.
It should work with the user's current i3 configuration; however, new features may require some additional setup.
+
+Before starting the Sway installation, ensure that a graphics card (GPU) is installed and configured correctly.
+Refer to the section crossref:x11[x-graphic-card-drivers,drivers for your graphics hardware] for guidance.
+This step is essential for the Sway compositor to function properly.
+
In the forthcoming examples, a fresh installation without migrating any i3 configuration will be assumed.
To install Sway and valuable components, issue the following command as the root user:`

thoughts?

@@ -370,6 +370,11 @@ To start Hikari, use the following command:
[[wayland-sway]]
== The Sway Compositor

[NOTE]
====
Make sure you have read this section 'How to Identify and Configure Drivers for Your Graphics Hardware'. otherwise it would give error "0 GPU detected".
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Ghodawalaaman
Copy link
Author

@dbaio I like how you have done it. It feels much more natural than putting it inside Note tag.

can I add the changes given by you into my pull request?

@dbaio
Copy link
Member

dbaio commented Jan 5, 2025

@dbaio I like how you have done it. It feels much more natural than putting it inside Note tag.

can I add the changes given by you into my pull request?

Yes, please. I can push this PR to the tree tonight or tomorrow

@dbaio
Copy link
Member

dbaio commented Jan 7, 2025

Thanks, this has been submitted to the tree.

@dbaio dbaio closed this Jan 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants