Warning: Can't synchronize with repository "(default)" (/home/git/ome.git does not appear to be a Git repository.). Look in the Trac log for more information.

Changes between Version 3 and Version 6 of Ticket #9835


Ignore:
Timestamp:
11/29/12 16:18:39 (11 years ago)
Author:
hflynn
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • Ticket #9835

    • Property Summary changed from BF docs (round 2 from PR 190) to BF docs improvements
  • Ticket #9835 – Description

    v3 v6  
    11Items from [https://github.com/openmicroscopy/bioformats/pull/190 PR 190] which did not make it into 4.4.5. 
    22 
    3 == PDF == 
    4  * The short explanatory blurb from the frontpage is duplicated by the next page (of "Goals"). Seems odd. Could/Should more introductory text be moved to the front page? 
    5  
    63== Front Page == 
    7  * Is the link to genomebiology for "OME Data Model" on the front page really the best link? (also first paragraph under Goal of B-F). (Maybe this comes post-BF as a general "OME-XML" doc effort") 
     4 * Is the link to genomebiology for "OME Data Model" on the front page really the best link? (also first paragraph under Goal of B-F). (Maybe this comes post-BF as a general "OME-XML" doc effort" - YES, not for here) 
    85 
    96== User == 
     
    118 * The Dataset structure table is a pretty important concept that could use some explaining. 
    129 * Consider renaming the imagej pages to something more memorable (cf. bf-features-in-imagej.txt). Perhaps an imagej subdirectory would be better, or a consistent naming scheme. (``imagej-*.txt``) 
    13  * Similarly, the OMERO section which is just a bullet point should be moved "top-level". 
    1410 
    1511== Developers == 
    16  * First bullet points under "API documentation" have an extra gap because the "More thorough examples" are a link while the other is a toctree. Perhaps restructure the text to link inline? 
    17  * http://www.openmicroscopy.org/site/support/bio-formats-staging/developers/service.html shows the weird yellow CSS issue. (Not sure why) 
     12Remaining issues to be tackled by Melissa e.g. change MacPort recommendation to HomeBrew and make sure all the commands/methods are up to date. 
    1813 
    1914== New content (separate PR?) == 
     
    2217 * Example under "troubleshooting.txt" of how to use google (site:lists.o.org.uk) in order to search the mailing list. 
    2318 
    24  * Add files from components/bio-formats/doc to developer docs in sphinx 

1.3.13-PRO © 2008-2011 Agilo Software all rights reserved (this page was served in: 0.14672 sec.)

We're Hiring!