pop-os / docs

Pop!_OS Documentation Site

Pop!_OS Documentation

https://pop-os.github.io/docs

contribute

clone docs repo

git clone [email protected]:pop-os/docs.git docs
cd docs

create a branch

git checkout -b <your-branch>

make changes and push

git add . && git commit -m "chore: did stuff" && git push --set-upstream origin <your-branch>

via the GitHub ui, make a PR to main branch

when a push/merge to main occurs it will automatically build and deploy to https://pop-os.github.io/docs

docs's Issues

Manage Applications section incorrectly indented in SUMMARY.md

Manage Applications should not be a subsection of Customize Pop.

Add sections for running non-Linux programs in Manage Applications

Add procedures explaining and showing how it is possible to run Windows programs in Linux using applications like Bottles, Wine, and Lutris.

• https://support.system76.com/articles/bottles/

Project status

👋 Hey Pop team! Found the hosted ghpages site via a search for Pop!_Shop issues and see there is some good info in here, but not active for over a year and many signs of being unfinished.

If these are not going to be maintained, might the hosted site be redirected and README pointing to some better place for docs and this repo archived?

Indent images in ordered list in installation.md

Images should be indented after each step.

links hard to read against midnight background

For my eyes the links are hard to read against the Discovery_Midnight #102a4c background. A change of the link color from #2b79a2 to Pop!_Blue #48b9c7 makes them much clearer in my opinion.

Some of the Etchers screenshots are not in focus

Some Etcher screenshots in bootable-usb-using-macos.md and bootable-usb-using-windows.md are out of focus.

Many screenshot programs remove focus when you activate them. Here's how I've been fixing these:

1. Launch the GNOME screenshots program and set a 5 second timer.
2. Click take screenshot.
3. Go into your virtual machine and do the thing.
4. Copy screenshot from GNOME screenshot to clipboard.
5. Paste screenshot into new GIMP project.
6. Screenshot the needed section of the image in gimp project with another screenshot program.

Addition to file sharing.

I'm making this suggestion rather than pushing PR so the idea can be discussed for its merit. Regarding https://support.system76.com/articles/file-sharing, I'd like to see the addition of the easy-to-get, Ready OOTB, secure file sharing resource with the Warp Flatpak.
Links:
https://gitlab.gnome.org/World/warp
https://github.com/flathub/app.drey.Warp
https://flathub.org/apps/details/app.drey.Warp

This software works like a charm. It's based on the Magic Wormhole and would only need minimal document space.

Another reason to consider adding something like this would be due to COSMIC DE moving away from GNOME related tools. It might be a good interim until COSMIC/POP has something native. Warp is Rust based so maybe easy enough to fork??

Side bar scrolls left and off the page when selecting nested pages

With the Introduction page selected, the side bar looks good:

but when I select the Introduction page, the side bar shifts to the left and is partially cut off:

The side bar also scrolls left and right a bit, so I'm betting there's a width that just has to be massaged a little.

Update Popsicle Instructions

Step four of creating a bootable USB using Popsicle shows one method to compare the hash by clicking "Check" while the hash field is blank. It should probably be updated to show users that they can copy/paste the hash into the field and press "Check".

Customize-pop.md bullet consistency

Bullets on this page should be consistent with header sections throughout the mdbook:

Short description of what the user can do (dash) sentence further elaborating the features and functions described in the section

Add ability to drag and drop applications between workspaces in using-workspaces.md

When creating this document, I wasn't aware that you could drag and drop application windows between the small workspace previews. This method should be added.

Configure Hardware should go before Customize Pop

Configure hardware covers usage basics. I think it should come after Navigate and before Customize.