Skip to:

  1. Skip to Jira Navigation
  2. Skip to Side Navigation
  3. Skip to Main Content

Create readme for the 0.3 release to replace the PDF

Description

It would be great to include a file in the source code bundle that explains to developers how to find documentation for Fluid components.

I am thinking of a README.html file or perhaps Documentation.html that provids a quick list of pointers into the wiki for documentation. Something that we can include in the source bundle for developers. This might just be a simple export of the ToC page as HTML, or perhaps just a very brief explanation of where to go to find all of Fluid's documentation along with a URL.

iteration10

Environment

None

Activity

Show:

Michelle D'Souza January 14, 2011 at 3:30 PM

Reopening these issues so I can add the release component to them.

Paul Zablosky June 9, 2008 at 6:52 PM

A README with a reference to the ToC was created.

Colin Clark June 2, 2008 at 2:48 PM

The latter makes sense to me. The README would be pretty large if we tried to also stick the ToC into it.

Anastasia Cheetham June 2, 2008 at 12:08 PM

Colin, by "resolve," do you mean merge the two files? Or just update the text file to refer to the new html documentation file?

Colin Clark May 30, 2008 at 10:48 PM

We should also resolve this new documentation file with the README.txt file in the SVN repository:

http://source.fluidproject.org/svn/fluid/components/trunk/README.txt

This particular README is really helpful because it compiles together all of the basic information you need to start using Infusion: licensing, what's in the release, and known issues.

Fixed

Details

Assignee

Reporter

Time tracking

1h 30m logged

Components

Fix versions

Priority

Created May 27, 2008 at 6:00 PM
Updated January 14, 2011 at 3:37 PM
Resolved January 14, 2011 at 3:37 PM