On 2015-12-10 07:14, Martin Schreiber wrote:
> 
> A suggestion: what about to move the files in an appropriate directory on 
> MSEuniverse?

To quote my answer from 3 September:

"
Hiding it in a different repository... My personal opinion is that that
is the wrong thing to do. Nobody is going to find it, and it will be
more disconnected from the actual MSEgui code it is documenting. Also
creating a "documentation release" means it will have no notion of what
MSEgui version was used to create that release. All way to disconnected.
"

> It would allow more people to directly push there documentation 
> contributions

No, they will still need to create an account first, get given access to
the MSEUniverse, then only can they push.

The more "git" (Distributed Version Control System) way of doing things
would be for them to generate patches that you can simply apply with
'git am', or even better, they can push their documentation
contributions to their own public MSEgui repo (Github, GitLab,
SourceForge, own hosted server etc), and you can simply pull, review and
merge such changes. The latter is by far the simplest and least effort
for you. The latter is my preferred way of receiving contributions for
fpGUI, and it works really well.

No need for yet another repo managed by Martin. No disconnect from what
is being documented - MSEgui. Versions are known and always the same.

Developers expect documentation with frameworks. Java, Qt, GTK, LCL,
fpGUI... they all include documentation with the code in the same repo.
Demos can be another story, but not documentation.


> If everyone would push the answers he gets here on the list to MSEdocumenting 
> it would grow fast and I could do more work on actual programming. ;-)

Exactly what I'm doing, and it doesn't even take 5 minutes. Even the
skeleton documentation is useful and you can search the whole framework
instantly, see a class hierarchy, make personal notes (in the case of
INF) etc.


Regards,
  - Graeme -

-- 
fpGUI Toolkit - a cross-platform GUI toolkit using Free Pascal
http://fpgui.sourceforge.net/

My public PGP key:  http://tinyurl.com/graeme-pgp

------------------------------------------------------------------------------
_______________________________________________
mseide-msegui-talk mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/mseide-msegui-talk

Reply via email to