Documentation missing

[Kronoxis]

Is it possible to add the documentation to the repository? This way, PRs implementing feature requests can also include documentation, or mistakes in documentation can be fixed by the community.

Ideally the documentation would be a document that can be easily tracked by git. I'm not sure how the netlify app user manual is built, but do you reckon it can be used with git, and if not, transformed to something that can, e.g. a markdown readme? This could also be a community goal, we can rewrite sections of the current documentation into markdown together piece by piece.

[GMihalkow]

It already exists. Although in a separate repo.
We are yet to write contribution guidelines for the docs though.

https://github.com/Dreamteck/splines-docs

[Kronoxis]

Good to know.

I wonder if there's any convenient way of contributing to docs linked through git similarly to how the utilities currently work. To be more specific, if I fork both the splines and utilities repo, add a utility function, push that to my fork, and then use that utility in a splines class and push that to my splines fork, the utilities change will be shown as part of the modifications. This way, when the feature gets merged, both the splines and utilities repos should pull their relevant changes. (at least, I think this is what would happen, haven't tried it yet)

If that could work for docs too, that would be ideal, but that would involve adding the docs as a module to splines and that may complicate things for #6 significantly, as we probably don't want the whole node project to be pulled into unity.

[Kronoxis]

If I understand the documentation from Unity correctly, it should be possible to simply add the docs as module which by default are not loaded in by the package manager, and add the utilities as dependency. This would ensure that the utilities are present when splines is added to the project, and that the docs are (somewhat¹) conveniently available to those who contribute on git.

Let me know your thoughts.

Footnotes

1. I'm not sure if I've been using the correct flow. I had to fork all git repos, clone splines with submodules enabled, change refs in git config to point to my forks and then push to one repo before the other for it to correctly show up. ↩