search

john-h-k / MathSharp

A vector and matrix library written in C# using hardware intrinsics
MIT License
697 stars 49 forks source link

[PROPOSAL] Adding a documentation project to Math# #39

Open Kavignon opened 5 years ago

Kavignon commented 5 years ago

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.

john-h-k commented 5 years ago

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

Kavignon commented 5 years ago

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!

john-h-k commented 5 years ago

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

varon commented 5 years ago

Can help with website hosting costs.

Kavignon commented 5 years ago

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!

john-h-k commented 5 years ago

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

brucificus commented 4 years ago

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