qmlweb
Design documents
There is a lot of good discussion going here on individual commits and issues, but i miss a bit a global view of how we see qmlweb after the merge and restructuring. Im all for merging as much as possible before we refactor, (i suffer a bit from refactor-itis), but i also see there are some interconnected issues with diverging solutions in different forks and i think we need a better idea of what we are working towards. The biggest one of these issues is the file loading and importing, which i made a separate issue for: #...
I would like to propose that we make some design documents in the repo: requirements/scenarios, modules structure, apis, abstractions and how they relate etc. Nothing too formal, but at least something concrete we can refer to and revise to capture conclusions from discussions we have in various threads.
Good idea? waste of time?
I also think this is needed. Is there something provided on github for this? Maybe a wiki?
Was initially thinking just a file or two on the repo, but wiki could be an option... Wed 24 Feb 2016 kl. 19:47 skrev Sam Segers [email protected]:
I also think this is needed. Is there something provided on github for this? Maybe a wiki?
— Reply to this email directly or view it on GitHub https://github.com/qmlweb/qmlweb/issues/71#issuecomment-188401549.
Will try to make a template one of the next days. as for wiki vs file. i like the idea of having a file, then we can propose changes with pull requests and discuss them there. Also forces us to keep the document short and to the point. Might clutter the commit log, but for me thats not an issue? We could use the wiki for background information/analysis if necessary.
Another option is to have a separate repo for the wiki as described here