▲ | henrebotha 4 days ago | |
Genuinely, I am trying to improve things. Making documentation more readable has a real cascading positive effect. Of course, most of these PRs are tiny — just a word or two — but that means it takes me almost no time to submit them, so the ROI is still positive. One of the most enraging things to me is when a text search of documentation fails because the word I'm searching for has been misspelled in a key place. That's one of the things I'm trying to solve for. I'm also just a stickler for good style. It bums me out when people misuse heading levels. Heading level is not a font size markup! Of course doing this does generate activity on my GH, but I think all of us have probably moved on from caring much about the optics of little green squares. Also like someone else said, it's just fun. I like typing and making Git do a thing and using my nice keyboard. | ||
▲ | jkubicek 4 days ago | parent | next [-] | |
> I'm also just a stickler for good style. It bums me out when people misuse heading levels. Heading level is not a font size markup! I want to start a company with you and mandate all documents use appropriate styles. | ||
▲ | saratogacx 3 days ago | parent | prev [-] | |
One of the things I've done that has helped with my writing consistency is to use whatever version of "project" or "library" your LLM of choice has and pre-load it with a technical writing guide (I used the Red Hat Technical Style Guide[1]) and push my docs through that to identify improvements. It has been a great way to keep my own writing consistent and remove randomness from just having my own writing improvement prompt. |