master
km0 2 years ago
parent a50541b1a8
commit e0be7f66da

Binary file not shown.

@ -23,8 +23,8 @@ https://git.xpub.nl/kamo/dlist
[overview] [overview]
A small documentation framework and a pubblication A small documentation framework
grounded in the development of situated software focused on the development of situated software
in the context of our group in XPUB in the context of our group in XPUB
[our group] [our group]
@ -36,8 +36,8 @@ coming from various background
[our ecosystem*] [our ecosystem*]
the main space where these software run is the Soupboat the main space where these software run is the Soupboat
a server running on a Raspberry Pi a self-hosted server running on a Raspberry Pi
that hosts tools and prototypes homing tools and prototypes
https://hub.xpub.nl/soupboat/ https://hub.xpub.nl/soupboat/
the main space used to document things is the wiki the main space used to document things is the wiki
@ -51,36 +51,47 @@ https://git.xpub.nl/
[outcome] [outcome]
it is actually composed by two parts composed by two parts
that held hands together that held hands together
1 1. documentation framework 🐔
2. documentation of our ecosystem 🥚
[docs]
a pubblication a pubblication
a soft index of the tools a soft index of our tools
we developed and are developing developed and in development
what do they do what do they do
where to find them where to find them
how to use them how to use them
from where they come from from where they come from
and where they are going
how we are documenting them how we are documenting them
and how to contribute how to contribute
2 [framework]
the writing machine to work on it a framework to document
a system as simple as a markup language our system of software and practices
\(like this flat markup used to write this)
easy to read and easy to write
flexible and expressive enough flexible and expressive enough
to articulate our tools as common to be useful for us
and this work of documentation as a form of care 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) (how do you want to make it)
[process] [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 --> to keep track == minimum viable product of documentation
@ -88,12 +99,18 @@ that means where to gather them
[iterative] [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] [collaborative]
How to include others in this process?
How to meet the needs of our community?
>> distinction between public and userbase >> distinction between public and userbase
>> userbase > public >> userbase > public
>> userbase < public >> userbase < public
>> internal public ~ external public

@ -74,4 +74,4 @@ def parse(file):
line = f.readline() line = f.readline()
return json.dumps(parsed, indent=4) return json.dumps(parsed, indent=4)
# print(parse('list.1dl')) print(parse('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-structure-proposal/
https://hub.xpub.nl/soupboat/~kamo/projects/si16-frontend-design/ 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.

Loading…
Cancel
Save