POV-Ray : Newsgroups : povray.documentation.inbuilt : wiki vs. html : Re: wiki vs. html Server Time
10 Dec 2023 20:46:27 EST (-0500)
  Re: wiki vs. html  
From: Le Forgeron
Date: 27 Nov 2018 16:46:18
Message: <5bfdbb2a$1@news.povray.org>
Le 27/11/2018 à 21:27, dick balaska a écrit :
> I noticed the hgpovray has a section on the wiki, and I thought that
> would be neat for qtpovray. I should at least port it to wiki foo
> because, reasons.
> But I like distributing the html with the app.
> So, my question is, how do y'all manage the multiple editions of your
> docs?  IIRC, the wiki is now the master and you port it to html?  How?
> Thanks.

On github, it's MD, which get served as HTML. (but the MD of github &
bitbucket are different, in regard to hierarchy and links, and TOC handling)

hgpovray's doc based on 3.7 was in github & bitbucket. But it is
cumbersome to edit: it's its own repository, and to see it, I have to
commit & push.
Of cource you can have MD editor with preview... but not always working
with github version of MD, or bitbucket version, so once done for a
page, it need to be done again because it does not work on that server.

And hgpovray 3.7 was also documented in a single big page in the wiki
(experiments before hgpovray ever existed), such big page being splitted
now as features are reported in hgpovray 3.8.

For hgpovray based on 3.8:
* I dropped bitbucket
* the doc is in the wiki, in hope someday it might be useful if some
feature get into official
* the github doc is not in the same repository, it's two clones to make,
one for source of app, one for doc, so maybe all that should be in
github doc section is a link to the wiki, but I have not cleaned yet.
(there is no branches for the doc repository, as far as I know, on
github, so documenting multiple branches can be challenging)
* there is more control in the wiki, and it's easier to edit & preview.

Post a reply to this message

Copyright 2003-2023 Persistence of Vision Raytracer Pty. Ltd.