tag/02/index.html


<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>02 - Opening</title>
    <link rel="stylesheet" href="/style.css">
</head>
<body>


<header>
    <h1>
        doc
        doc
        doc
    </h1>
    <div class="sub">
        documenting code documentation
    </div>


    <div class="info">

        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

    </div>

    <div class="attempt">
        second attempt focuses on:
        openings: the first few sentences of documentation pages
        like in the game of chess, opening as statement
    </div>

</header>

<main>

    assumes a certain kind of reader
    address where to link the necessary resources

    <div class="opening">
        <p>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.</p>
        <a href="https://vueuse.org/guide/">VueUse</a>
    </div>

    refer to a particular language context (in this case french), a similar choice was made for vue, by the same developer
    quick, faster and leaner development, compared to what?
    lean from lean manufacturing?
    for "modern" project. what is modern here?

    <div class="opening">
        <p>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.</p>
        <a href="https://vitejs.dev/guide/">Vite</a>
    </div>

    refer to a particular language context (in this case german)
    it began as a simple collection: acknowledge the origins of the project
    repeat WSGI three times without explaining, implying a certain kind of technical knowledge
    time composite documentation: last sentence has been added later on.

    <div class="opening">
        <p>
        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.</p>
        <a href="https://werkzeug.palletsprojects.com/en/2.2.x/">Werkzeug</a>
    </div>

    fast, expressive, extensible
    three features oriented to different needs
    the figure of the engine
    refer to the python community

    <div class="opening">
        <p>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.</p>
        <a href="https://jinja.palletsprojects.com/en/3.1.x/intro/">Jinja</a>
    </div>

    focus on accessibility and scale
    time composite documentation: last sentence has been added later on.
    acknowledge the origin of the project

    <div class="opening">
        <p>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.</p>
        <a href="https://palletsprojects.com/p/flask/">Flak</a>
    </div>

   set the context: everyday life + artistic practice
   digital life deeply connected with the idea of office and workspace
   artistic operating system could sound like a disclaimer

    <div class="opening">
        <p>The Screenless Office is an interface for everyday (digital) life without a screen. It is an artistic operating system.</p>
        <a href="https://gitlab.com/bhowell/the-screenless-office">The screnless office</a>
    </div>

    address a problem: to keep track of otherwise scattered pads
    acknowledge external actors, such as the mediawiki api
    refer to a specific context: people orbiting around xpub and lens based wiki, using etherpad

    <div class="opening">
        <p>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.</p>
        <a href="https://git.xpub.nl/kamo/pad-bis">pad-bis</a>
    </div>

    small app small server, probably for small drawings?
    open to plurality of sources and destinations
    architecture overview (sources and destinations connected through an express server via websockets)

    <div class="opening">
        <p>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.</p>
        <a href="https://git.xpub.nl/kamo/drw">drw</a>
    </div>

    address a specific public
    to improve workflow, what does improve mean ? faster? less keystrokes?

    <div class="opening">
        <p>Emmet is a web-developer’s toolkit that can greatly improve your HTML & CSS workflow</p>
        <a href="https://docs.emmet.io/">Emmet</a>
    </div>


</main>

</body>
</html>