During our release process discussion this afternoon, we made some
decisions regarding how to better manage our documentation. This is a
summary of our decisions, so that I can double-check that I got it
right, and in case any others wish to comment:
1) For API documentation, we will move to automatically-generated docs
based on comments in the code. I will investigate possible tools for
this.
- Anyone working on code should keep this in mind, and start
ensuring that all of our public APIs are documented in the comments.
- This will not happen for 0.8, though we should keep it in mind
and feel free to make improvements to the comments, if we're in there
anyway for bug parade work.
NB: One thing we forgot to discuss was the actual *distribution* of
these auto-generated docs. I think that ideally, we will have http://docs.fluidproject.org
, and the release process will include generating the HTML and posting
it there. Alternatively (additionally?) the generated HTML could be
bundled into the zip file.
Thoughts, anyone?
2) Tutorials will live in an un-versioned, collaboratively-editable
space. This space will continue to be the wiki, for now.
--
Anastasia Cheetham [email protected]
Software Designer, Fluid Project http://fluidproject.org
Adaptive Technology Resource Centre / University of Toronto
_______________________________________________________
fluid-work mailing list - [email protected]
To unsubscribe, change settings or access archives,
see http://fluidproject.org/mailman/listinfo/fluid-work
