MathSharp icon indicating copy to clipboard operation
MathSharp copied to clipboard

[PROPOSAL] Adding a documentation project to Math#

Open Kavignon opened this issue 6 years ago • 7 comments

  • Proposal

Using DocFX, it’s possible to automatically get a documentation website that is in synced with the source implementation. A good use case for this proposal is to quickly check the differences between the math library here and the one located in opentk.

Alternatives

None at the time.

Kavignon avatar Aug 23 '19 22:08 Kavignon

That seems a good idea. Note worthy tho that I literally have no money

john-h-k avatar Aug 24 '19 19:08 john-h-k

No worries! DocFX can let you have a static website for others to consume on their own when they access the repo or fork it for instance!

Kavignon avatar Aug 24 '19 19:08 Kavignon

Then that's awesome. I can't do it for at least a week, but am happy to review PRs for it

john-h-k avatar Aug 24 '19 19:08 john-h-k

Can help with website hosting costs.

varon avatar Aug 25 '19 00:08 varon

Here, it's going to be a bit difficult since DocFX is looking for XML documentation and there's no doc in the implementation. I'll still add the Documentation project and we'll see what it'll bring up!

Kavignon avatar Aug 27 '19 13:08 Kavignon

Awesome, if you can add it i can get XML docs started

john-h-k avatar Sep 17 '19 21:09 john-h-k

If ya'll are looking for "free": You can host a static website using GitHub pages, and you can continuously deploy it with GitHub actions.

I recently did this for a different project: https://github.com/foxguardsolutions/Foundation/pull/30

brucificus avatar Dec 14 '19 16:12 brucificus