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

Improved Documentation For Inept Users #14

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

Conversation

HugoCortell
Copy link

@HugoCortell HugoCortell commented Oct 7, 2024

The documentation assumes that the user is familiar with the tools & workflows involved. Considering that Monospace Web provides a really accessible way for users to build beautiful websites (just make a markdown file!), the lack of appropriate documentation that targets the lowest common denominator is a missed opportunity.

This pull request seeks to alleviate this problem by modifying the existing readme file to include detailed instructions for non-technical users, while also preserving the original build method for power users that can understand the whole process from a single nix command.

The easter egg included is meant as harmless fun and a critique of the maintainers. Considering that this isn't being sold and marketed for its inherent accessibility, and is instead hosted entirely on a website whose target demographic is programmers, it's only understandable to expect a smidget of technical knowhow from visitors. Plus being on github probably creates a bit of survivorship bias towards believing that the average person knows what nix is.
Regardless, I want to believe that the maintainers of this repo also want as many people as possible to use the Monospace Web, so I'm hoping that this documentation will be well received. There are many troglodytes like me who dislike package managers and much prefer to install dependencies by hand.

This updated documentation is meant to guide you from start to end. While originally, it gave you the tools and assumed you could piece together what to do from there. While users could be trusted to just google how to use Pandoc (and piece together from context that Pandoc is what is used to convert the md file to an html file), providing an exact command for them to use will probably replace a small handful of frowns with smiles.

Also, please kindly sqash before merging. In my weak defence, it is 1am.

@mZynths
Copy link

mZynths commented Oct 15, 2024

LGTM :D

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

Successfully merging this pull request may close these issues.

2 participants