Skip to content
This repository has been archived by the owner on Jun 14, 2019. It is now read-only.

Help folder / documentation #43

Open
1 of 6 tasks
ceholden opened this issue Oct 27, 2014 · 0 comments
Open
1 of 6 tasks

Help folder / documentation #43

ceholden opened this issue Oct 27, 2014 · 0 comments

Comments

@ceholden
Copy link
Owner

So since we don't have the usual documentation for this yet, yank out the help folder entirely. This isn't some kind of API so a Sphinx based documentation style that came with the Plugin Builder defaults isn't useful. Would prefer to just write documentation that is accessible via Github (gh-pages too?) as markdown, which gets built into HTML if anyone wants it within the deployment. So:

  • Rip out existing help folder and fix Makefile
  • Write documentation for how to use the plugin
  • Write documentation for how to write a timeseries driver
  • Re-create Makefile to use pandoc to go from markdown to HTML
  • gh-pages site? https://help.github.com/categories/github-pages-basics/
  • Link to repository and help pages from plugin
@ceholden ceholden added this to the 1.0 milestone Oct 27, 2014
@ceholden ceholden modified the milestones: 1.0, 1.1 Jun 15, 2015
@ceholden ceholden modified the milestones: 1.1.0, Info and docs Dec 3, 2015
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant