react-juce

react-juce copied to clipboard

There's a lot to document here and I haven't done any of it :)

Not sure what the tool of choice here is... git storybook looks cool, github pages would be nice, maybe docsify? Either way, should pick one and get started!

Hi @nick-thompson

First, many thanks for this project, looks very promising.

I think the easiest for documentation is probably Github Pages + Doxygen. I'm doing it in a couple of my public repositories. See tobanteAudio/modEQ & Docs or tobanteAudio/taetl. The docs get build after every push via Travis CI. I can create a pull request with the .travis.yml & Doxyfile.in config if you want to. CI wouldn't be a bad idea anyway. :)

Hi @tobanteAudio! Apologies for the slow reply, I'm going through your comments now, thanks so much for writing.

I'm definitely interested in github pages, I think that's the smart move there. I love the idea of CI to build and publish the docs too (and just in general), but I'm a little bit unsure of Doxygen. Would Doxygen support documenting both the C++ API (like ReactApplicationRoot) and the JavaScript API (like the different View types exported by default) in a cohesive way? I think whatever tool we choose would ideally cover both seamlessly, but maybe that's too much to ask

Hi @nick-thompson I think something like Docusaurus could help here as it allows to get OOTB a nice and easy website where you can document the project. It does not generate documentation based on your source but it's flexible enough so that you can document the api and usages with markdown as you go - https://docusaurus.io/ - and then deploy to github pages || netlify.com || now.sh

Thanks @codenakama ! I definitely like the looks of Docusaurus, I think we can go ahead with it.

My time is tight right now but I started trying to put better docs in the Wiki: https://github.com/nick-thompson/blueprint/wiki. There's so much more to write there but it's a start, and at least should hopefully help kickstart a transition to docusaurus.

Writing back to report that documentation has now been moved into the repository at docs/, built with Docsify, and hosted at https://nick-thompson.github.io/blueprint/#/. Should hopefully be a much more fluid process now that documentation changes can be made right in the repo and with pull requests 🙌

@nick-thompson, This is really cool. Hadn't heard of Docsify. Be cool to add the vscode debugger setup stuff to this. Also keen to sort out documentation for the Canvas API implementation etc.

Totally! I hadn't heard of it either, but it was wiiicked simple to set up, and looks really nice. There's a lot of documentation still to write, hopefully this change makes it easier

** The below is a list of topics we need to document under the new Docsify system to close this issue **

• [ ] Update "Getting Started" with CMake/Projucer guide.

• [ ] Add custom duktape configs guide (part of task 1?)

• [x] Add VSCode debugger guide,

• [ ] Add Typescript "Getting Started" guide.

• [ ] Add hot-reload workflow guide (beforeBundleEval, afterBundleEval) etc.

• [ ] Add data/event flow guide (dispatchEvent, registerNativeMethod)

• [ ] Add style props / layout guide (Flexbox, ViewProps etc.)

• [ ] Add "Custom View" guide (registerViewType)

• [ ] Add view/component event guide (SyntheticEvent etc)

• [ ] Add Canvas drawing guide.

• [ ] Add SOUL setup guide (possibly belongs at SOUL repo but might be useful here)