diff --git a/demo/.demo.1dl.swp b/demo/.demo.1dl.swp new file mode 100644 index 0000000..95a54d6 Binary files /dev/null and b/demo/.demo.1dl.swp differ diff --git a/demo/demo.1dl b/demo/demo.1dl index 126281f..81d1eee 100644 --- a/demo/demo.1dl +++ b/demo/demo.1dl @@ -23,8 +23,8 @@ https://git.xpub.nl/kamo/dlist [overview] -A small documentation framework and a pubblication -grounded in the development of situated software +A small documentation framework +focused on the development of situated software in the context of our group in XPUB [our group] @@ -36,8 +36,8 @@ coming from various background [our ecosystem*] the main space where these software run is the Soupboat -a server running on a Raspberry Pi -that hosts tools and prototypes +a self-hosted server running on a Raspberry Pi +homing tools and prototypes https://hub.xpub.nl/soupboat/ the main space used to document things is the wiki @@ -51,36 +51,47 @@ https://git.xpub.nl/ [outcome] -it is actually composed by two parts +composed by two parts that held hands together -1 +1. documentation framework 🐔 +2. documentation of our ecosystem 🥚 + + +[docs] a pubblication -a soft index of the tools -we developed and are developing +a soft index of our tools +developed and in development what do they do where to find them how to use them from where they come from +and where they are going how we are documenting them -and how to contribute +how to contribute -2 -the writing machine to work on it -a system as simple as a markup language -\(like this flat markup used to write this) -easy to read and easy to write +[framework] +a framework to document +our system of software and practices flexible and expressive enough -to articulate our tools as common -and this work of documentation as a form of care +to be useful for us +and accessible for others +a way to articulate code as common +and documentation as a form of care + (how do you want to make it) [process] -facilitate the design of a system to keep track of our tools -offer some prompts on how to do it -that means where to gather them + + +Facilitate the development of a framework to document our software. +Offer proposal to the group. + + + + --> to keep track == minimum viable product of documentation @@ -88,12 +99,18 @@ that means where to gather them [iterative] +Start the research by documenting past prototypes. +Keep going and put more care in the docs of current prototypes. +Plan and explore documentation as the focus of future prototypes. + [collaborative] +How to include others in this process? +How to meet the needs of our community? >> distinction between public and userbase >> userbase > public >> userbase < public - +>> internal public ~ external public diff --git a/flat.py b/flat.py index 4cbb07e..b7cd0de 100644 --- a/flat.py +++ b/flat.py @@ -74,4 +74,4 @@ def parse(file): line = f.readline() return json.dumps(parsed, indent=4) -# print(parse('list.1dl')) +print(parse('list.1dl')) diff --git a/list.1dl b/list.1dl index a26a354..486f5a9 100644 --- a/list.1dl +++ b/list.1dl @@ -121,3 +121,18 @@ 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/ + + +(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 an general overview.