doc doc doc

documenting code documentation
hello! welcome this is an archive to navigate through different ways of making code documentation navigate in the sense of learning how to find things, like there is no clear path / a practice to learn / shared practice personal practice
second attempt focuses on: openings: the first few sentences of documentation pages like in the game of chess, opening as statement

VueUse is a collection of utility functions based on Composition API. We assume you are already familiar with the basic ideas of Composition API before you continue.

VueUse

Vite (French word for "quick", pronounced /vit/, like "veet") is a build tool that aims to provide a faster and leaner development experience for modern web projects.

Vite

werkzeug German noun: “tool”. Etymology: werk (“work”), zeug (“stuff”). Werkzeug is a comprehensive WSGI web application library. It began as a simple collection of various utilities for WSGI applications and has become one of the most advanced WSGI utility libraries.

Werkzeug

Jinja is a fast, expressive, extensible templating engine. Special placeholders in the template allow writing code similar to Python syntax. Then the template is passed data to render the final document.

Jinja

Flask is a lightweight WSGI web application framework. It is designed to make getting started quick and easy, with the ability to scale up to complex applications. It began as a simple wrapper around Werkzeug and Jinja and has become one of the most popular Python web application frameworks.

Flak

The Screenless Office is an interface for everyday (digital) life without a screen. It is an artistic operating system.

The screnless office

The Padliography is a tool to keep track of our pads. It is built to interact with the MediaWiki API, and it uses XPUB & Lens-Based Wiki’s pages as archive.

pad-bis

A small app for collecting drawings in real time. Runs on a small express server that connects sources (where to draw) and destinations (where to display) via websockets.

drw

Emmet is a web-developer’s toolkit that can greatly improve your HTML & CSS workflow

Emmet

Hello worlding

An opening is a declaration of intents, it manifests intentions. These intentions are glued together in the smallest context possible of a sentence. They are like a trailer for a movie, or the thumbnail of a youtube video. Often exagerate, click-bait, ideological. How and why these different facets come together? They are a visibile traces of choices made during development, choices that sometimes are made evident within the documentation, and sometimes remain unanswered.

From the perspective of someone writing code and therefore code documentation, I'm interested in exploring these openings both from a stylistic and technical point of view. Leveraging on form, they are a perfect device to set the stage for code: a way to illuminate code choosing a particular angle, intensity and target, revealing some aspects and conceiling other ones. From a technical perspective they attach onto already constituted systems of meaning, such as a particular technology, a programming language, framework, or coding paradigm. They trigger mutual influences between code and context, like a telescope that can be used from both sides: from the code to the bigger context, and from the bigger context to the code. A way to infiltrate.

As someone that reads code documentation, I'm interested in make these openings more eloquent. Or even just having some tool or practice to decode them. Inflating the opening in a way that differ from the rest of the documentation.

Every keyword is a branch. Zettelkasten vibes here.

Also a small confession: I'd prefer to exhibit something non digital for grad show.

A scultureeeeeeeee a data sculpture a 3d sculpture of how openings are aligned in 3d space. (pffffffff) Like a 3d diataxis - political compass. Ahaha.

Draw an image draw an image