grammar improvements #671

RayBB · 2025-12-31T06:39:46Z

Followup to #668

Here's I'm making overall grammar improvements rather than the simple typos found by codespell.

Some of these are a bit more subjective but my overall goal is to improve readability.

I'll also note that we probably should use a template for the part about needing a usb stick, adapter, etc but that can be a change for later.

AdityaGarg8 · 2025-12-31T16:27:58Z

docs/distributions/debian/installation.md

 # Introduction

-This guide shall help you in installing a Debian or Ubuntu based Linux distro, which is not available as a modified ISO with T2 support.
+This guide will help you install a Debian- or Ubuntu-based Linux distro, which is not available as a modified ISO with T2 support.


It's fine without the hiphen

AdityaGarg8 · 2025-12-31T16:28:36Z

docs/distributions/debian/installation.md


 !!! Warning "Installation fails when installing the bootloader (Eg: GRUB)"
-    It is possible that during installation, when the installer is installing the bootloader (GRUB in most cases), the installation may fail. This is because the distro's ISO is using an old Linux kernel which doesn't support writing to the NVRAM of T2 Macs. In such a case, boot into the ISO again. When the initial menu gets displayed having options to try/install the distro, press "e" on the option you otherwise would have chosen to install. This will open the command line. Add `efi=noruntime` to the command line and press "F10" to boot. This should fix the issue.
+    During installation, when the installer is installing the bootloader (GRUB in most cases), the installation may fail. This is because the distro's ISO is using an old Linux kernel which doesn't support writing to the NVRAM of T2 Macs. In such a case, boot into the ISO again. When the initial menu gets displayed having options to try/install the distro, press "e" on the option you otherwise would have chosen to install. This will open the command line. Add `efi=noruntime` to the command line and press "F10" to boot. This should fix the issue.


I kinda prefer the old wording here.

AdityaGarg8 · 2025-12-31T16:31:21Z

docs/distributions/manjaro/deprecation.md

-No support for installation will be provided starting from 2023. If you want to install Manjaro on your Mac after 2023, you're on your own.
-
-For kernel for existing installation, until the end of 2023. LTS will be supported longer for those who can't switch for whatever reason.
+Support for installation ended in 2023. For existing installations, kernel support ended at the end of 2023. LTS kernels were supported for longer for those who could not switch.


LTS kernels were supported for longer for those who could not switch.

Just remove this line.

AdityaGarg8 · 2025-12-31T16:32:33Z

docs/distributions/nixos/home.md

 ## New to NixOS?

-NixOS is not exactly an easy Linux distribution to use. If you are entirely new to Linux or had no prior experience with Nix, we strongly recommend you choose another distro like [Fedora](../fedora/home.md) first. Should you decide to proceed further, the [Nixpkgs manual](https://nixos.org/manual/nixpkgs/unstable), [Zero-to-Nix](https://zero-to-nix.com/), [NixOS Options Search](https://search.nixos.org/options) and [the official Nix wiki](https://nix.dev) could come in handy.
+NixOS is not the easiest Linux distribution to use. If you are entirely new to Linux or have no prior experience with Nix, we strongly recommend you choose another distro like [Fedora](../fedora/home.md) first. Should you decide to proceed further, the [Nixpkgs manual](https://nixos.org/manual/nixpkgs/unstable), [Zero-to-Nix](https://zero-to-nix.com/), [NixOS Options Search](https://search.nixos.org/options) and [the official Nix wiki](https://nix.dev) could come in handy.


I liked NixOS is not exactly an easy Linux distribution to use tbh

AdityaGarg8 · 2025-12-31T16:38:49Z

docs/guides/audio-config.md


 - edit `/etc/default/grub` and update `GRUB_CMDLINE_LINUX` to include `intel_iommu=on iommu=pt pcie_ports=compat`
 - Apply your edits by running `sudo update-grub` on ubuntu or `sudo grub-mkconfig -o /boot/grub/grub.cfg` for other distros
-    - Note that, `grub`'s command line interface names might differ on different distros, if the commands like `grub-xxx` are not found, try `grub2-xxx` alternatives instead. For example, it should be `sudo grub2-mkconfig ...` instead of `sudo grub-mkconfig ...` on Fedora 36.


I wonder what's wrong with Note that?

In the trainings I've done on technical writing they usually explain it something like this:

It is redundant (if you're putting it in the docs it's already important)

It can be a bit patronizing

People get desensitized to it when it appears often

If something really is important and needs to be called out then you should warning indicator or something strong

So the general recommendation is to not use it. However, I'm just providing suggestions so if you want to keep it that's no problem.

AdityaGarg8 · 2025-12-31T16:42:33Z

docs/guides/hybrid-graphics.md

 ## Issues

-If you experience system freezes, then the laptop's fans becoming loud, before the whole computer shuts off (CPU CATERR), or if the amdgpu is making the computer too hot, consider trying:
+If you experience system freezes, then the laptop's fans become loud, before the whole computer shuts off (CPU CATERR), or if the amdgpu is making the computer too hot, consider trying:


then the laptop's fans get loud

This maybe is better

Now that you call closer attention to this section I think you're right it could be phrased a little better. So I reworded the sentence a bit.

AdityaGarg8 · 2025-12-31T16:43:26Z

docs/guides/postinstall.md

-In rest cases, you probably won't need to follow this guide.
+In other cases, you probably won't need to follow this guide.

-If you have used a T2 ISO, **make sure you have followed the [distro specific guide](https://wiki.t2linux.org/distributions/overview/) for your distro before continuing further.**


What's wrong with further?

Again, it's pretty subjective. In technical writing training they generally advise to avoid redundant words (try to keep things concise and informative). So in this case "continuing further" and "continuing" have pretty much identical meanings but when we speak there's a tendency to add "further" to the end.

Perhaps it's related to using "go" in a similar context. If you say "before you go" it could mean "go further" or "go back" but "before you continue" just already means "continue further" and "continue back" doesn't make sense.

Enough pontificating. As I said, it's subjective. So if you like it better with "further" than let me know and we can leave it.

AdityaGarg8 · 2025-12-31T16:44:08Z

docs/guides/postinstall.md

 ## Installing a kernel for T2 support

-Installing a kernel with support for T2 Macs is required in order to get the Keyboard, Trackpad, Touch Bar, Audio, Fan and Wi-Fi working.
+Installing a kernel with support for T2 Macs is required to get the keyboard, trackpad, touch bar, audio, fan, and Wi-Fi working.


Let's keep the capital letters here in order to kinda highlight what were are providing.

That's a great point. I've made them bold, that puts emphasis on it in a way that makes the importance clear.

AdityaGarg8 · 2025-12-31T16:45:07Z

docs/guides/postinstall.md


 ## Adding support for customisable Touch Bar

-By default the Touch Bar works in the same mode which Windows Bootcamp uses on Linux. If you want to customise it, you can install `tiny-dfr` on your distro.


British vs American. Interesting.

The person who sent PR is American so it does make sense for him to change it to American English spelling. I use both, switching whenever I feel like switching though.

Probably. I am not sure what standard most spellings are following here. I usually use British spellings but that doesn't mean the wiki needs to do that though.

The wiki's spellings are mixed so I think we should consolidate but not sure which way to follow.

Apologizes for this. My spell check automatically picked it up and I didn't question it. I agree it should be consistent one way or another.

Perhaps there's a case to be made since Apple gets more money from the Americas than other parts of the world there's probably going to be more American English users coming (not that it matters much).

However, I ran a quick script over the md files use breame and it seems fairly split (ignoring the install/disk).

If you let me know, I can fix this in this PR or a separate one.

AdityaGarg8 · 2025-12-31T16:49:08Z

docs/guides/preinstall.md

-   - set Secure Boot to **No Security**
-   - set Allow Boot  Media to **Allow booting from external or removable media**
+   - Set Secure Boot to **No Security**
+   - Set Allow Boot Media to **Allow booting from external or removable media**


Probably put Secure Boot and Allow Boot Media in "" or bold it. Not sure which is better.

Fixed with bold

RayBB · 2025-12-31T18:44:39Z

@AdityaGarg8 I've addressed all of your feedback. Also, if you have any other stylistic preference let me know and I'll try to accommodate them. With your approval, I hope to do a few more PRs of improvements to the docs (as reported in other issues).

AdityaGarg8 · 2025-12-31T18:50:57Z

@AdityaGarg8 I've addressed all of your feedback. Also, if you have any other stylistic preference let me know and I'll try to accommodate them. With your approval, I hope to do a few more PRs of improvements to the docs (as reported in other issues).

Let me celebrate New Year lol.

RayBB added 4 commits December 30, 2025 22:40

first pass grammar changes

204df72

imrpove a few more grammar issues

e1ff4b4

fix a few more typos and update links

bb781d5

a few more small grammar fixes

676a1e9

RayBB force-pushed the grammar-improvements branch from d4a0688 to 676a1e9 Compare December 31, 2025 06:40

AdityaGarg8 requested changes Dec 31, 2025

View reviewed changes

address pr feedback

7c4725f

RayBB requested a review from AdityaGarg8 December 31, 2025 18:38


		## Adding support for customisable Touch Bar

		By default the Touch Bar works in the same mode which Windows Bootcamp uses on Linux. If you want to customise it, you can install `tiny-dfr` on your distro.

grammar improvements #671

Are you sure you want to change the base?

grammar improvements #671

Uh oh!

Conversation

RayBB commented Dec 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RayBB commented Dec 31, 2025

Uh oh!

AdityaGarg8 commented Dec 31, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

RayBB commented Dec 31, 2025 •

edited

Loading