Hi, Anastasia: Sounds good. I have created a ticket here:
http://issues.gpii.net/browse/GPII-1119 I am working on the pull request at the moment. I am limiting myself to clearly documented functions that are not already flagged for removal. Where possible I will reuse content from the 1.4 docs. Cheers, Tony On Wed, Mar 11, 2015 at 4:53 PM, Cheetham, Anastasia <[email protected]> wrote: > > Tony, thanks for the offer of help with the documentation. > > The first link you referenced is actually for version 1.4 of the code, > and so is not up-to-date. The “more general” version is the more recent > version, and it has been restructured a bit compared to the old version. > > You’re right that we haven’t yet migrated the Framework API docs to the > github repository. We’re investigating the possibility of automatically > generating these docs from comments in the source code, but until we > finalize those plans, the creation of documentation for as-yet undocumented > functions is certainly welcome, as would be the verification of existing > documentation for framework functions. > > I suggest we create a top-level folder (i.e. inside the ‘documents’ > folder) called FrameworkFunctions. We can create pages in there for > functions such as fluid.templateString(). Sound good? > > > On Mar 11, 2015, at 7:00 AM, Tony Atkins <[email protected]> > wrote: > > Since I learned about a handful of framework functions in my reading > that would be of use in my work, I went through the docs to see what I > might have missed in earlier reading. It looks like the framework > function documentation > <http://wiki.fluidproject.org/display/Infusion14/Framework+API>has not > yet been migrated from the wiki. Since I plan to review these functions in > more depth over the next few days, I would like to offer to migrate over > what we have, and add documentation for at least the undocumented functions > I already am aware of (such as *fluid.templateString*). > > Before I do that, I want to make sure I'm targeting the right place. > This is the closest I could find in the GitHub documentation repo: > https://github.com/fluid-project/infusion-docs/blob/master/src/documents/to-do/FrameworkAPI.md > > The placeholder content in that page points to a more general version of > the API docs <http://wiki.fluidproject.org/display/docs/Framework+API> > which does not include function documentation, but it still seems like the > right place. I would appreciate quick confirmation from the team before I > start the pull request, as it will save time. > > > -- > Anastasia Cheetham – [email protected] > Inclusive Design Research Centre > Inclusive Design Institute > OCAD University > >
_______________________________________________________ fluid-work mailing list - [email protected] To unsubscribe, change settings or access archives, see http://lists.idrc.ocad.ca/mailman/listinfo/fluid-work
