From mboxrd@z Thu Jan  1 00:00:00 1970
Received: from mimir.eigenstate.org ([206.124.132.107]) by ewsd; Mon Jul 27 19:50:59 EDT 2020
Received: from abbatoir.fios-router.home (pool-74-101-2-6.nycmny.fios.verizon.net [74.101.2.6])
	by mimir.eigenstate.org (OpenSMTPD) with ESMTPSA id dd935bba (TLSv1.2:ECDHE-RSA-AES256-SHA:256:NO);
	Mon, 27 Jul 2020 16:50:59 -0700 (PDT)
Message-ID: <97186701FFF3C64903FE2A1834258976@eigenstate.org>
To: khm@sciops.net, 9front@9front.org
Subject: Re: [9front] The 9 Documentation Project
Date: Mon, 27 Jul 2020 16:50:58 -0700
From: ori@eigenstate.org
In-Reply-To: <20200727224744.GA61790@wopr>
MIME-Version: 1.0
Content-Type: text/plain; charset="US-ASCII"
Content-Transfer-Encoding: 7bit
List-ID: <9front.9front.org>
List-Help: <http://lists.9front.org>
X-Glyph: ➈
X-Bullshit: virtualized abstract shader-oriented app 

> Old electronics manuals (specifically, here thinking of Textronics
> oscilloscope manuals) used to have a section entitled "Theory of
> Operation" which went over at a high level what each component and/or
> panel button did and why, culminating in an explanation of how they
> worked together in common scenarios.  Such a document explaining what
> these services (ndb, factotum, secstore, rpcu, etc) do without getting
> distracted by administration instructions may be a valuable document.

Yes. that's the kind of thing I was wishing we had. Something like
/sys/doc/comp.ps. I think the preferred way of managing docs for me
would be /sys/doc, mirrored to the web -- but I don't care enough to
argue over that: if a wiki gets people to write, I'd be happy with
that.

I'd started sketching out something for ndb, though who knows when
I'll have time to get it done.