john-h-k / MathSharp

A vector and matrix library written in C# using hardware intrinsics

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

[PROPOSAL] Adding a documentation project to Math#

Kavignon opened this issue · comments

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.

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

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!

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

commented

Can help with website hosting costs.

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!

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

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: foxguardsolutions/Foundation#30