Skip to content
This repository has been archived by the owner on Jan 30, 2020. It is now read-only.

Check Documentation For Other Things #90

Closed
GeeH opened this issue Jan 20, 2016 · 0 comments · Fixed by #105
Closed

Check Documentation For Other Things #90

GeeH opened this issue Jan 20, 2016 · 0 comments · Fixed by #105

Comments

@GeeH
Copy link
Contributor

GeeH commented Jan 20, 2016

Check docs for other problems

TLDR; Cast your eye over the documetation for any problems not covered in the other issues

Things slip through the net, so check the documentation for other problems that have been missed. Common other problems include

  • Bullet lists (should be single * then space at the start of line)
  • Inline code - should be marked by three backticks at start and finish
  • bookdown.json file is correctly formated and has the right escaping
  • Links between documentation using RST have been stripped
  • Any other RST has been removed correctly
  • Anything and everything not covered

If you end up fixing the same problem over and over, please ping Gary Hockin - we may be able to add bespoke issue for that problem, or fix in automated capacity

@weierophinney weierophinney self-assigned this May 4, 2016
weierophinney added a commit to weierophinney/zend-inputfilter that referenced this issue May 4, 2016
- Renamed files to remove `zend.input-filter.` prefix.
- Checked documentation for code blocks (Fixes zendframework#89).
- Edited all documentation for content and formatting (Fixes zendframework#90).
- Converted from bookdown to mkdocs.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants