From e0be7f66da3b332dcbc5eaa885cd31edf900b2d6 Mon Sep 17 00:00:00 2001 From: kamo Date: Mon, 12 Dec 2022 01:38:38 +0100 Subject: [PATCH] demo ass --- demo/.demo.1dl.swp | Bin 0 -> 12288 bytes demo/demo.1dl | 57 +++++++++++++++++++++++++++++---------------- flat.py | 2 +- list.1dl | 15 ++++++++++++ 4 files changed, 53 insertions(+), 21 deletions(-) create mode 100644 demo/.demo.1dl.swp diff --git a/demo/.demo.1dl.swp b/demo/.demo.1dl.swp new file mode 100644 index 0000000000000000000000000000000000000000..95a54d61836a57d5c57d8714189e72685132b98a GIT binary patch literal 12288 zcmeI2O^h5z701gsK==qCd`D%hNRGqK+6E%aB8~z$5C`zajw7VSh??%2na*~1wW_Lj zc7n2SK-`cb2%nb#5jWt%ff%@jQ*sFsAS4qhkO1PA0~|Q;@q0Brv$LzL;1CXxdgPyH zx3=o_d;j-QV|jrercD|PG^rT+a!oag`l7ythM%R802 z3BQJ4z}I0H9s>iH;1t{fN8wq1Vc@IqC9sggUGR_Fl&YbEEASxP2N&UX`1{+H`V~A6 zzl3Mthwv4sp@PrACY*r3y-lg#!O!3Zd>K9qpMaBa4F2_2rTz&w;A!|V{0P1YyYLuX zhr8f|@BvtZ_rOv3^IMeqEj$B1fp5bXA%`pQAY6nsxE20-t5Uy#pToBxLI4lf;32pK z_ru5GV{jDy^k$`AhL_-v@CSGio`Ubg_u#wm1bhuX2O3^@lTyEjoA4Yw3s1r4;Ze8@ z=izoxAh~^<_X<7*>u?lqvVH@ehMz+J>J{h}_`fP};esyeXnk!;-L%89$n>tZJNs4? zo7!Og&;+YL)NPZ+?quiS-ohcKR*oF9qb&ZHJ=viSExo+3;$_aScNKLO3s>u*jZRaILTadyvQA2!Q2x7xAS2gKk|5p?5S zW<$7#Db?&mZvUOw!-kFe|J7O_Cchts~O<0UB z&KesAT0LNGqsOkO$H`FBMqP=e%ROFW6*WLx^~yLDC6Mb%b%yD-Bt`JA^|6!rGSIIoq|NUs;(aD7$^uPnTF&jZEnOori8-T3-c)w#{FWSCSWig`ZWN~oF_6b> zc9}r?@5dt4hX|mFqvSfqI0scJF(n%>t^XY?A7(+xy zd3<`~+J}h|4?^^`3Y|`_Vr;_s_4RQP2Rnp1sLS=`Vq@}GS$uR_Y!!oPzGY-{W%I)1 zHWcG}J>@dsT`VdaG&Yqf9f_V6aiRkn($<8OBEI*zsn68T+~-g zXolANncgT4I=8Gz>TlU6oR$oTcUL0KQnL%xnd->G989h3e}J#K9v{Vns)>9eO(H56IVFj^>5sR}=zW;~*s$9@lEO*i3zS%3))i&EQi{AxT=|Y`9OnL@q5TWjxdpWn~gSrc7>I=Gw znyY2dX4XfQRFQNxt(Vy$?hLJzn>8U_B_bt$W4>DuD@*}dl7nSYb3^l)Lyj80Wt{8{ zizE;QJY-jx-@n|YlY*<7%*^Pj5&5Kz{T7AFCy#M!##Svp6v(s0naX4|Ggo0a&-`OV zqjjhB+=mcVdXywM$R&m=%jR8ZEWRm2Mngy!HMgRnjw^Tk_;JQGUtCvu@1;&Ii+bP1 Hdx!cDLZBhK literal 0 HcmV?d00001 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.