Clean up markdown formatting for hooks docs
Created by: seancolsen
When we imported documentation on hooks from the wiki, we used an automated script. Due to the somewhat cumbersome and limited formatting options of the wiki, the automated migration produced sub-par markdown for these hooks docs. They're readable, but not so great looking. It would be nice to make them all look good.
Here's an example of a good one that has been cleaned up to use proper markdown formatting and look nice: https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_merge/
Here's what I mean when I say clean:
-
Specify language (e.g. php
) after the three backticks which precede code blocks so that it will be displayed with syntax highlighting -
Use backticks to display parameter names in inline monospace (and any other machine-readable text, which as noted in our style guide, should be displayed with inline monospace) -
Clean up any other funky formatting (e.g. broken lists, etc.) -
Create separate tickets for any other cleaning that the page needs but can't be easily performed (e.g. if the page is missing a function signature or other important content)
Because this issue contains hundreds of changes which can be performed independently, I set up a google spreadsheet to track progress on all the pages on this small project. (This way it'll be easier for multiple people to work on it at once during a docs sprint.)
We can close this ticket once all the rows in that spreadsheet read "Cleaned".