Documentation Bonfire

bonfire

what

A small framework to document projects on the soupboat using a shared flat markup list as source. 

where

https://hub.xpub.nl/soupboat/bonfire/ 

how

Edit the fireplace list in the /var/www/bonfire  

assessment

ahah editing in productionn ops 

flask-example

what

a tutorial for setting up a flask app in the soupboat 

where

https://git.xpub.nl/manetta/flask-example 

doc

Kamo and Chae are working on the documentation! 
With drawings! 
And a general overview. 

workbook

what

A tool to keep track and annotate configurations for different instruments 
to facilitate learning process 

where

https://hub.xpub.nl/soupboat/workbook/ 

doc

organized in 6 parts 
1. intro/overview 
2. what/why, intentions 
3. how to add a new instrument 
4. how to add a new patch 
5. how to add a new snippet 
6. how to contribute in the development 
https://hub.xpub.nl/soupboat/workbook/documentation 
https://pad.xpub.nl/p/modcms_documentation 
--> draft in progress 

dev

main repo 
https://git.xpub.nl/supisara/workbook 
svg to interactive panel 
https://git.xpub.nl/kamo/panel 
cables system 
https://git.xpub.nl/kamo/spaghetti 

links

brainstorming pad 
https://pad.xpub.nl/p/modcms 

refs

reference for spaghetti cables system 
https://hub.xpub.nl/soupboat/~kamo/projects/spaghetti/ 
reference for interactive panel generator 
https://hub.xpub.nl/soupboat/~kamo/projects/panel/ 

padliography2

what

an interface to archive links on the wiki 
mainly used for pads 
several instances of the archive can be initialized 
directly from the interface 
so multiple archives can coexhist together 

where

https://hub.xpub.nl/soupboat/padliography 

doc

https://git.xpub.nl/kamo/pad-bis 
https://pzwiki.wdka.nl/mediadesign/Padliography 

notes

--> I'd like to see more memes, they help me understanding the process more 
--> I like the toads 
--> more images please! 
--> I wouldn't mind having more of these side-notes, why some decisions have been made or should be made 
--> Hi! Great documentation! I am not a developer. So why is the "development" section much easier to follow than the "quick start"? 
--> nice tool, nice colors, clear layout, but curious to hear from the maker why it is an interesting tool to use and work with? What is interesting about it for you? Also, in which context did this tool emerge? How is it embedded in that context? How did this influence your choices? Is the tool referring to other tools, can you cite them in some way? 
--> I think the syntax could be more accessible by writing shorter sentences, or sentences that only focus on 1 thing. I'll elaborate after lunch 

dev

v2 -- current 
https://git.xpub.nl/kamo/pad-bis 
v1 
https://git.xpub.nl/kamo/PADliography 

SI16 API

what

Learning how to walk while catwaking 
A set of functions to mess around with vernacular language processing 
Published as a choral API 
Sparse architecture 

doc

A collective work where everyone contributed with some functions 
Written in Python inside Jupiter Notebooks 
And documented in the very same notebooks 
With description, examples and references about input and output 
And then aggregated together as endpoints for the API 
Multiplayer approach to documentation 
That means docs with diverse voices 
maybe not always clear 
but really interesting way of work collaboratively 
--> we didn't managed but it could make sense in a process like this to have an editorial meeting at the beginning to align a bit the intentions and then an editorial review after, to adjust contents 
Example: 
Shout function 
https://hub.xpub.nl/soupboat/si16/functions/shout/ 
More documentation for the backend is available 
https://hub.xpub.nl/soupboat/~kamo/projects/si16-backend/ 

where

https://hub.xpub.nl/soupboat/si16/ 

dev

main repo 
https://git.xpub.nl/grgr/si16-cat-walking/ 

links

si16 manifesto 
https://hub.xpub.nl/soupboat/si16/intro/ 
si16 previous prototypes 
https://hub.xpub.nl/soupboat/~kamo/projects/si16-API-strapi-nuxt-prototype/ 
https://hub.xpub.nl/soupboat/~kamo/projects/si16-API-express-prototype/ 
https://hub.xpub.nl/soupboat/~kamo/projects/si16-structure-proposal/ 
https://hub.xpub.nl/soupboat/~kamo/projects/si16-frontend-design/ 

EL GATO SPURUNNITO

what

    
            /\____/\ 
         =( Φ ﻌ Φ  )= 
           /            \ 
          /_|_|___(_-|====,