Skip to content

GitLab

Closed (moved)
(moved)
Created by Karsten Loesing@karsten

Clean up the doc/HACKING/* docs a bit

As part of last week's 1-1-1 task exchange I said I'd "review doc/HACKING/* in master". Please find branch hacking in my public repository for some typo fixes and trivial changes.

And here are a few more comments:

  • doc/HACKING/GettingStarted.txt ends with an empty section called "Where do I go from here?". Maybe that section should just go away, unless we feel like we should suggest something to the reader.

  • doc/HACKING/HelpfulTools.txt contains two typos in "berformance pottlenecks" which I didn't fix, because I wasn't sure whether it's a Monty Python joke or just two typos.

  • What do you think about turning all these .txt files into .md and unifying the markup? Some people might prefer reading these files using their favorite graphical Markdown display tool, rather than their text editor. Maybe this could be an easy follow-up 1-1-1 task.

To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information