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 #5

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

Check Documentation For Other Things #5

GeeH opened this issue Jan 20, 2016 · 0 comments · Fixed by #8
Assignees
@weierophinney
Labels
documentation EasyFix

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-loader that referenced this issue May 5, 2016
@weierophinney
Prepared documentation for publication
2b5d958 
- Converted from bookdown to mkdocs.
- Renamed files to remove `zend.locator.` prefix.
- Checked and corrected all headers. (Fixes zendframework#3)
- Checked and corrected all code blocks. (Fixes zendframework#4)
- Checked and corrected all tables. (Fixes zendframework#6)
- Checked and corrected all blockquotes. (Fixes zendframework#7)
- Reviewed and edited for content and formatting. (Fixes zendframework#5)
@weierophinney weierophinney mentioned this issue May 5, 2016
Merged
weierophinney added a commit that referenced this issue May 5, 2016
@weierophinney
Merge branch 'feature/documentation'
f580cf3 
Close #8
Fixes #3
Fixes #4
Fixes #5
Fixes #6
Fixes #7
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@weierophinney weierophinney

Labels
documentation EasyFix
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Prepare documentation for publication weierophinney/zend-loader
2 participants
@weierophinney @GeeH