WattDepot Docs are live.

9 views
Skip to first unread message

Philip Johnson

unread,
Dec 6, 2013, 9:47:44 PM12/6/13
to wattdep...@googlegroups.com
I spent today fiddling with Viewdocs (the package Robert discovered yesterday) and have a skeleton documentation system up and running:


Most of the links go to pages without much text in them, but at least it's all organized and people can focus on writing content, not formatting or organization.  

Here's the page I wrote to document how to write documentation:


Let me know if anything's not clear.  It would be good for everyone to try doing a little editing of the documentation to make sure you're all comfortable with it and you don't encounter any problems. 

For the moment, commit documentation directly to the master branch.  This is due to an inadequacy of Viewdocs; I will let you know when it's fixed.  

The only other downside I can find with Viewdocs after 8 hours of use is that you end up having to edit the template.html file directly to manually manage the table of contents (i.e. the drop down menus).  That's a very small price to pay for what is otherwise a pretty nifty system.  Commits currently go live within about 10 seconds.  If the system stays robust and responsive, I doubt we'll need to look further for WattDepot (although if we do, I think keeping everything in markdown files organized by subdirectory will make it pretty easy to port.)

I wanted to put a picture of the admin web interface on the home page, but mopsa and heroku appear to be down. :(

Philip

Carleton Moore

unread,
Dec 6, 2013, 10:47:18 PM12/6/13
to wattdep...@googlegroups.com
I took down mopsa since it was running under my account and is slightly broken.  Should be up by Monday.


--
You received this message because you are subscribed to the Google Groups "wattdepot-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to wattdepot-use...@googlegroups.com.
To post to this group, send email to wattdep...@googlegroups.com.
Visit this group at http://groups.google.com/group/wattdepot-users.
For more options, visit https://groups.google.com/groups/opt_out.

Reply all
Reply to author
Forward
0 new messages