Starting Developer Docs

Ahead of the project becoming un-moored from having someone working on it as their job, I’ve started to assemble some very skeletal developer documentation at https://develop.flucoma.org/ with the aim of starting to make it easier for other people to join in.

So far it’s limited to contribution and build system notes, plus two quite detailed walkthroughs of object code aimed at the @tremblap 's of this world who like to jump in the deep-end.

Because the task is basically limitless, it would definitely be helpful if potentially interested people could let us know what they would like to see prioritised for covering next. My assumption is that most people would be interested primarily in making new objects, and so this would come ahead of starting to cover the dark and musty corners. (not least because I’d like a lot of those dark and musty corners to change / go away as part of a future effort to make it easier to develop new objects!).

Anyway, use this thread for suggestions, or take advantage of the handy github links on the docs pages to make suggestions more directly.

6 Likes

Dear all

I am reading this resource for understanding how development can be done in various ways, from bug reports to testing to C++. I’m working on the C++ part at the moment, but if you are curious about the codebase and how to help keep it alive, read this fantastic site - @weefuzzy wrote it in a way that you don’t need to be as deep as he is in the world of coding to understand how to contribute.

I am refraining from tagging a few people here who told me they wanted to get involved over the years :slight_smile:

(and yes, I am also seeking funding to try to move things faster, but code maintenance is hard if impossible to fund, so for now it is a labour of love)

3 Likes