Mvvmcross: Documentation request

[scotch83]

Request for MvvmCross Reference documentation

Hello,

it would be nice if possible to have a reference of the framework like a standard language reference.

Like this:
https://developer.android.com/reference/android/Manifest.permission.html
With all the classes and methods and related descriptions and use.

Thank you

[younas-bangash]

one of the best platform and it have worst documentation mostly their webpages are down

[Cheesebaron]

@younas-bangash your comment isn't appreciated. Instead of going from issue to issue and flaming us, I suggest you leave constructive criticism instead. I.e. it would be better to point out which exact part is down or is unclear.

@scotch83 this has been discussed before. This would require us to add XML docs to every public method and class. The amount of stuff having to be maintained is way too much for us with the amount of resources we have right now.

[nickrandolph]

@Cheesebaron well said - I'm going to close this issue as we already have documentation as a TODO.
@younas-bangash we're always looking for volunteers - please submit PRs to include appropriate documentation instead of raising issues with thing you'd like to see
@scotch83 we're always conscious of the need for documentation but there is a massive trade off between documentation and implementing features and bugs. As you can see from the commit history the bulk of the work is done by only a few people. We'd love more assistance in the form of PRs rather than issues outlining a wishlis of features.

[younas-bangash]

@Cheesebaron accept my apology if my comment is not proper my point is not to criticise anyone if you feel that then again I apologize for that

[scotch83]

sorry guys, the last I meant to raise was such a storm. I got the answer to
open the issue from someone on the slack channel. I would not even think
about it as an issue, actually, but rather a todo. Btw did you consider and
documentation generator able to create at least a skeleton?
Thank you for taking your time on this anyhow. it s a great framework and
you have all my respect. Greets and have a nice day everyone!

Mattia Collalti

On Sat, 21 Apr 2018, 22:42 Younas Bangash, [e-mail] wrote:

@Cheesebaron https://github.com/Cheesebaron accept my apology if my
comment is not proper my point is not to criticise anyone, you do a nice
job I just point out that what you mention in the video is not working
that's it and I raised that issue #2801
https://github.com/MvvmCross/MvvmCross/issues/2801.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/MvvmCross/MvvmCross/issues/2806#issuecomment-383328223,
or mute the thread
https://github.com/notifications/unsubscribe-auth/ALG6evEe0JfF8fjGMHJJ1414zlfNygQ_ks5tq5nQgaJpZM4TYbvi
.

[nickrandolph]

@scotch83 there's no problem creating the issue so that we have something to track requests for documentation against (even if we then close the issue). As @Cheesebaron mentioned we need to be careful about adding more maintenance (usually what happens with generators) which just won't happen.
Take for example we'd all love to have complete test coverage, and so the question becomes: are we adding more value by writing documentation, fixing bugs, adding features or writing tests. Usually bug fixing wins in nearly every case.
We'd love for the community to contribute back by adding documentation they find useful.

[scotch83]

Good point! Have a good day ahead all!

Mattia Collalti

On Sun, 29 Apr 2018, 00:15 Nick Randolph, [e-mail] wrote:

@scotch83 https://github.com/scotch83 there's no problem creating the
issue so that we have something to track requests for documentation against
(even if we then close the issue). As @Cheesebaron
https://github.com/Cheesebaron mentioned we need to be careful about
adding more maintenance (usually what happens with generators) which just
won't happen.
Take for example we'd all love to have complete test coverage, and so the
question becomes: are we adding more value by writing documentation, fixing
bugs, adding features or writing tests. Usually bug fixing wins in nearly
every case.
We'd love for the community to contribute back by adding documentation
they find useful.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/MvvmCross/MvvmCross/issues/2806#issuecomment-385209067,
or mute the thread
https://github.com/notifications/unsubscribe-auth/ALG6egNUpdfvekWHtIIIAztPfUbVHx16ks5ttOoNgaJpZM4TYbvi
.