Opened 4 years ago

Closed 4 years ago

Last modified 4 years ago

#17450 closed enhancement (fixed)

Clean up the doc/HACKING/* docs a bit

Reported by: karsten Owned by:
Priority: Very Low Milestone: Tor: 0.2.8.x-final
Component: Core Tor/Tor Version:
Severity: Trivial Keywords:
Cc: Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

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.

Child Tickets

Change History (2)

comment:1 Changed 4 years ago by nickm

Resolution: fixed
Status: newclosed

Done, plus recommendations above. Thank you!

I renamed the files *md, though they're not md yet. That could indeed be a good 1-1-1 task!

comment:2 Changed 4 years ago by nickm

Milestone: Tor: 0.2.8.x-final
Note: See TracTickets for help on using tickets.