Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
Kavignon opened this issue Aug 23, 2019 · 7 comments
Open

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

Kavignon opened this issue Aug 23, 2019 · 7 comments

Comments

@Kavignon
Copy link
Contributor

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
Copy link
Owner

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

@Kavignon
Copy link
Contributor Author

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
Copy link
Owner

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

@varon
Copy link

varon commented Aug 25, 2019

Can help with website hosting costs.

@Kavignon
Copy link
Contributor Author

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
Copy link
Owner

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

@brucificus
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants