I really like that idea. Jochen, does the shipped documentation come in the form of a website or text files? Also, do you happen to have an example project that could be a good one to model?
Preston On Tue, Feb 10, 2015 at 4:41 AM, Jochen Wiedmann <[email protected]> wrote: > Standard procedure is (IMHO) to have the web site generated out of > src/site and ship the documentation generated out of the same place. > Thus, you have uptodate information in both places. > > Jochen > > > On Tue, Feb 10, 2015 at 7:11 AM, Till Westmann <[email protected]> wrote: > > Yes, we should avoid this redundancy and move everything to the website. > The > > top-level README could either contain a pointer to the website or the > > sources for the website. Since the source for the website is in apt it is > > actually quite readable. > > We also could consider "translating" our docs to markdown as that > probably > > understood (and written) by even more people :) > > > > Cheers, > > Till > > > > > > On 9 Feb 2015, at 17:36, Eldon Carman wrote: > > > >> We have installation instructions for VXQuery in two places: on the > >> website > >> and in the source tree as a README file. Currenlty, both places are out > of > >> date after our project graduation. I am concerned about maintaining two > >> sets of install instructions. Do you think we could move all > documentation > >> to the website? The README file could then be updated with a link to the > >> website. Thoughts? > > > > -- > Any world that can produce the Taj Mahal, William Shakespeare, > and Stripe toothpaste can't be all bad. (C.R. MacNamara, One Two Three) >
