stuartpb / leannotes

Some notes on how to build stuff on the Web
1 stars 0 forks source link

Lean Notes

This is a repository collecting all my thoughts on best practices and how-to guides for pursuing any sort of project or idea, whether it be a book, or a Web app, or a board game, or a 3D model, or a screenplay, or a microchip, or an essay, or a robot, or a logo, or whatever.

One of the things I struggle with is organizing these thoughts, so I've just dropped them into a big unordered bag called content/, and will describe the ways to browse through them below.

Layout

Content

All files under content are supposed to be accessible by links from this README (though most files are at least 1 link away).

Right now, all indexes into this content are in the content of the history section below.

Tags

There are images under assets/tags that are linked to within content files, for use in "tagging" certain kinds of text.

There's a document giving attribution (but not explanation yet) for the designs that will be used going forward here.

History

This repository, in its current state, is a mix of a few different projects I've started in the past:

The original Lean Notes series (first drafted on Trello)

I had a series of cards on a collection of Trello boards that I was using to mock up something : https://trello.com/leannotes

Back on January 18, I decided that, for accessibility's sake (and growing increasingly wary of Trello since its acquisition by Atlassian), I'd rather have these notes written as Markdown essays on GitHub (for easy replication to anywhere else Git is supported).

At the point in September 2018 when I merged these other projects below into this repo (and refactored it into files by UUID in the process)

But even when it came to the original boards on Trello, some chapters had little to no content beyond a title and a summary. Some Previous / Read On lists will lead off in directions that don't make any sense. Some sections may just link off to a GitHub Issue for details instead of having something written in the text itself (and that issue may have nothing in it).

See issue #1 for more information on the process of migrating these to GitHub; file a new issue if there's something specific missing that you'd want to know, and I'll answer if I can.

Even when it was on Trello, I was experimenting with multiple Tables of Contents, sorting by different criteria:

In the merged version of this repository, these Tables have been kept, and may be developed out to incorporate content from some of these other projects, or integrated into some larger "index documents " that may link to them as part of a larger-scope guide.

Meditations

This was a loose repository, meant to collect various small, quotable observations I'd had, similar to some of the cards on the Lean Notes boards. The thoughts here were meant to be short but deep and often koan-like - at one point, the repository was going to have the tagline "Understanding Stuart P. Bentley" - but it quickly sprawled into a situation where I'd start writing long, meandering diatribes that were far outside the already-pretty-liberal scope of content I was looking to collect in that repository.

To resolve the problem of overly-broad files that I kind of wanted to write or publish, I created barfspace, and moved some of the files I'd written for the meditations repository to there: however, for most of the files, I didn't feel right mixing them in with the formless, aimless morass of documents on barfspace, so I just kept that repository around until this repository's scope expanded enough to fit Meditations.

Here's the index page for meditations - the rest of the files therein will hopefully be better integrated with the rest of the notes going forward.

The how-i-roll repository

This was another, similar project to Lean Notes, but with more of an eye toward describing my own specific procedures I follow when setting out to do things. It contained three significant files, all of which fall under the category of "Stuff I Do in my Projects on GitHub".

A bunch of other loose concepts I'd made repos for

Here are some rough pages I'd originally planned to write entire books (or at least booklets) for, most of which had been linked in my list of Collected Writings, often with more text being dedicated to describing what the planned repository was intended to collect than actual text within the repository (for many of these, those descriptions form the bulk of their content here):

Roadmap

Going forward, I'm looking to go through this repository and start cross-referencing these sorts of sub-projects, breaking them out into separate documents in some places, and merging them together in others, until it's all a big ball of hair, with a few good points of entry that can help you see everything that can help you, in an order that makes sense.