Metadata
- Source
- FLUID-654
- Type
- Task
- Priority
- Blocker
- Status
- Closed
- Resolution
- Fixed
- Assignee
- Paul Zablosky
- Reporter
- Michelle D'Souza
- Created
2008-05-27T14:00:28.000-0400 - Updated
2011-01-14T10:37:18.428-0500 - Versions
- N/A
- Fixed Versions
-
- 0.3
- Component
-
- Release
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
Comments
-
Colin Clark commented
2008-05-30T18:48:05.000-0400 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.
-
Anastasia Cheetham commented
2008-06-02T08:08:05.000-0400 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 commented
2008-06-02T10:48:23.000-0400 The latter makes sense to me. The README would be pretty large if we tried to also stick the ToC into it. 🙂
-
Paul Zablosky commented
2008-06-09T14:52:01.000-0400 A README with a reference to the ToC was created.
-
Michelle D'Souza commented
2011-01-14T10:30:22.282-0500 Reopening these issues so I can add the release component to them.