On 26/04/2014 at 08:09, xxxxxxxx wrote:
Originally posted by xxxxxxxx
Perhaps I'm not totally clear on the goals of this project. Is the GitHub Repo meant to replace the current SDK documentation or is it supposed to be a supplement?
If it's meant to replace the docs, then there are a lot of nice things about the docs that the GitHub repo doesn't currently address:
* A general introduction to programming in C4D
* Links to helpful websites/books/etc
* A list of all SDK accessible classes & methods
* A searchable list of keywords
* Short examples (albeit few and far between) of how to use various methods right below their definition.
If the goal of the repo is to supplement the current docs, then I'd really like for there to be an easy way to point people from the current docs to all of the examples in the GitHub SDK where a given class/method is used. Ideally that would probably be something like wiki-editable docs, or a comments thread under each method where people can discuss them.
I think that the GitHub wiki would be a good place to start adding an FAQ section, and list of helpful tutorials, etc.
Also, there's a fair amount of overlap between the Python & C++ SDKs - because they're currently separate repos, any helpful documentation (about the way that C4D works) will need to be duplicated between the repos.
I'm not sure how to address these issues, but these are my first impressions.
It seems like I have been quite inaccurate about the project goals, I'm sorry for the confusion. The
SDKs are not meant to replace the documentation! They could never, they're just code examples.
They're meant to replace the existing SDKs (being collections of plugin examples) which you can find
in the Cinema 4D plugins/ folder for the C++ SKD and in the help/examples/ folder of the Python Docs
The code there is mostly rotten and old, little documented and bad structured.
We're working on a solution to integrate the SDK repositories with the online documentation already.
The GitHub wiki will soon be filled with such stuff, including our coding style guidelines (for which it would
be nice if contributors stick to it, but its not absolutely necessary)
We will try to keep the examples in sync, meaning that the same example plugin in Python is available
in C++ (see the starters/ folder in each repository for instance), but it's not always possible.