Codex quidvis

· psilore

documentation “Klaatu barada nikto”

Documentation

I started with “Keep it simple, stupid”, ended up in git. So testing several different setups, I came to the conclusion:
Use git for simplicity and fairly available on most platforms/services. Git is fairly common, so it provides options.

Ingredients

Structure

.
├── docs                                           # Bookshelf
│   ├── images
│   ├── jimmy-hoffa
│   │   └── README.md
│   ├── necronomicon                               # A book
│   │   └──chapter-1                               # Sub sections
│   │   │  └── oh-my-gawd-I-summoned-a-demon.md    # Page
│   │   │  └── alhazred-notes.md
│   │   └── README.md                              # Index
│   ├── quidvis
│   │   ├── docker
│   │   ├── gcloud
│   │   ├── raspberry-pi
│   │   │   └── pwnagotchi
│   │   │   │   └── README.md
│   │   │   └── README.md
│   │   ├── README.md
│   │   └── terraform
│   │       └── README.md
│   └── README.md
└── README.md

A lot of “README.md” 🥹, matter of taste if you want to add a README.md in each root directory.

Write it down, helps you remember

bookshelf

I aimed to simplify the process of tracking my activities and keeping an organized record of what I’ve accomplished. I wanted a solution that offered structure and clarity. After exploring various tools like Notion and other online services, I found that while they have many excellent features, they often felt overly complex to maintain.

Additionally, these tools typically require users to relinquish control over their data—an increasingly important consideration in today’s digital landscape. For those with abundant resources or financial independence, these concerns might not carry as much weight. However, for many of us, retaining ownership and maintaining simplicity are key priorities.

Steps

To view a timeline of your entries, you can use the git log command.

  1. Add stuff as usual to a branch, git add, git commit and so on…then just check log if you need a timeline of the entries.

    $ git log --oneline
* (HEAD -> pwnagotchi) added hardware setup image
* added parts list
* added steps to install
* added README
* (main) init

  2. [Optional] Squash merge your commits if you want a cleaner history

    git switch main
git merge --squash pwnagotchi
$ git log --oneline
(HEAD -> main) added pwnagotchi docs
init

Summary

  1. Create branch, this will symbolize the script for an actual book in the bookshelf
  2. Add stuff as usual (git add, git commit and so on…)
  3. Squash merge branch

history