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

handbook/wayland: improve synopsis readability #287

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

OwOday
Copy link

@OwOday OwOday commented Oct 27, 2023

Fix small typos and improve readability in first paragraph

@lwhsu
Copy link
Member

lwhsu commented Oct 27, 2023

Thanks, please set your preferred Author line in the commit. It's discouraged to use @users.noreply.github.com. You can check it at https://patch-diff.githubusercontent.com/raw/freebsd/freebsd-doc/pull/287.patch

OwOday and others added 2 commits November 2, 2023 17:10
Fix small typos and improve readability in first paragraph
@OwOday
Copy link
Author

OwOday commented Nov 2, 2023

Think I got it!

README Outdated Show resolved Hide resolved
@concussious
Copy link
Contributor

concussious commented Apr 27, 2024

If doc team accepts this contribution, it will go into the tree forever, so the log and message must be helpful to the people who will be sifting and searching through it.

Please squash everything into one commit with a specific title like:
handbook/wayland: improve synopsis readability
and edit this pr title the same way.

Comment on lines +53 to 59
Wayland is a communication protocol that can replace a display server such as Xorg. It differs from Xorg in several important ways.

First, Wayland is only a protocol that acts as an intermediary between clients using a mechanism which removes the dependency on an X server.
Xorg includes both the X11 protocol, used to run remote displays, and the X server, used to accept connections and display windows.
Under Wayland, the compositor or window manager provides the display server instead of a traditional X server.
Since Wayland is not an X server, traditional X screen connections will need to utilize other methods such as VNC or RDP for remote desktop management.
Second, Wayland can manage composite communications between clients and a compositor as a separate entity which does not need to support the X protocols.

Choose a reason for hiding this comment

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

i really like the suggestions, flow a little nicer than the previous version.

@OwOday OwOday changed the title Update _index.adoc handbook/wayland: improve synopsis readability May 1, 2024
Co-authored-by: Alexander Ziaee <[email protected]>
@@ -5,4 +5,4 @@ our toolchain in your own projects, please read the Documentation Primer at:

for information about the tools and formatting languages we use.
Chapter 1 has a Quick Start section, and Chapter 2 covers the software
and related items in more detail.
and related items in more detail.
Copy link
Contributor

@concussious concussious May 1, 2024

Choose a reason for hiding this comment

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

Oops, that didn't work. What I was suggesting is to revert proposed changes to the README entirely.

The current state of the PR damages the tree by changing the blame for line 9.

EDIT: and please don't credit me, I absolutely did not coauthor any of this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants