docs: Merge xsd-fu prerequisites into build instructions #1207
Conversation
Merge source code page with build instructions Move build instructions to the top since it's got a wider scope than contributing--non-developers need this
|
|
||
| The source code for this Bio-Formats release is available from the | ||
| :downloads:`download page <>`, and also from the `Git | ||
| <http://git-scm.com/>`_ repository. The latest Bio-Formats source |
There was a problem hiding this comment.
Is there any point to this initial Git link, the following sentences tell you how to access this, and this is rather repetitive.
There was a problem hiding this comment.
This is I think for the git software itself rather than our git repository; new users might need a pointer to this, particularly for Windows.
There was a problem hiding this comment.
Can you put the link on the 'Git' in the 2nd sentence then and just remove 'and also from the Git repository' in the this 1st one? It doesn't read very well.
| can configure the scripts to use your source tree instead of | ||
| **bioformats\_package.jar** in the same directory by following these steps: | ||
| Firstly, obtain a copy of the sources and build them (see | ||
| :ref:`source-code` and :ref:`source-building`). You can configure the |
There was a problem hiding this comment.
might be easier to just have to doc link here to the file since these two sections follow each other on the same page.
There was a problem hiding this comment.
We can use a crossref to the top-level section, but in general we should not be using (internal to the docs) links to pages or files for this purpose--it's not a proper crossreference and isn't as useful in the PDF which benefits from proper crossreferencing.
There was a problem hiding this comment.
Ok, what about 'see :ref:source-code and the building section which follows it' then?
|
Looks pretty good overall formatting-wise - I'm happy with this structure, it's an improvement. |
|
👍 on the improvements, reads well now thanks. |
ghost
mentioned this pull request
|
|
||
| Lastly, you can browse the :javadoc:`Bio-Formats Javadocs online <>`, | ||
| or generate them yourself using the "docs" Ant target. | ||
|
|
There was a problem hiding this comment.
Worth adding a note about line ending configuration on Windows here?
|
GenerateDS links now fixed, and note added about git on Windows. |
|
All fine with me now if OK with @hflynn. |
|
@hflynn not being here today, I will merge this to reduce noise on doc builds. Thanks @rleigh-dundee |
docs: Merge xsd-fu prerequisites into build instructions
ghost
deleted the
Merge source code page with build instructions
Move build instructions to the top since it's got a wider
scope than contributing--non-developers need this
--rebased-to #1208