changelog shortlog graph tags branches files raw help

Mercurial > org > docs / changeset: style update

changeset 28: a0017112db77
parent 27: 7975f0b22a64
child 29: e15ed25f6c16
author: Richard Westhaver <ellis@rwest.io>
date: Thu, 06 Jun 2024 23:15:50 -0400
files: core/api.org core/bin/homer.org core/bin/krypt.org core/bin/mailman.org core/bin/organ.org core/bin/packy.org core/bin/rdb.org core/bin/readme.org core/bin/skel.org core/ffi.org core/install.org core/readme.org core/stats.org core/tests.org core/todo.org demo/readme.org demo/stats.org infra/quickstart.org infra/readme.org infra/scripts.org infra/stats.org infra/todo.org meta/business.org meta/mindset.org meta/readme.org meta/style.org meta/tech.org meta/ulang.org meta/workflows.org nas-t/api.org nas-t/install.org nas-t/notes.org nas-t/quickstart.org nas-t/readme.org nas-t/roadmap.org nas-t/tutorial.org readme.org
description: style update
     1.1--- a/core/api.org	Thu Jun 06 00:36:21 2024 -0400
     1.2+++ b/core/api.org	Thu Jun 06 23:15:50 2024 -0400
     1.3@@ -2,7 +2,7 @@
     1.4 #+author: Richard Westhaver
     1.5 #+options: ^:nil toc:nil num:nil html-postamble:nil
     1.6 #+export_file_name: index
     1.7-
     1.8+#+setupfile: ../../clean.theme
     1.9 This documentation is automatically generated based on the default
    1.10 branch of the [[https://vc.compiler.company/comp/core][core]].
    1.11 
     2.1--- a/core/bin/homer.org	Thu Jun 06 00:36:21 2024 -0400
     2.2+++ b/core/bin/homer.org	Thu Jun 06 23:15:50 2024 -0400
     2.3@@ -1,5 +1,6 @@
     2.4 #+title: homer
     2.5 #+author: Richard Westhaver
     2.6+#+setupfile: ../../../clean.theme
     2.7 * help
     2.8 #+begin_src shell :results pp replace
     2.9 homer -h
     3.1--- a/core/bin/krypt.org	Thu Jun 06 00:36:21 2024 -0400
     3.2+++ b/core/bin/krypt.org	Thu Jun 06 23:15:50 2024 -0400
     3.3@@ -1,5 +1,6 @@
     3.4 #+title: krypt
     3.5 #+author: Richard Westhaver
     3.6+#+setupfile: ../../../clean.theme
     3.7 * help
     3.8 #+begin_src shell :results pp replace
     3.9 krypt -h
     4.1--- a/core/bin/mailman.org	Thu Jun 06 00:36:21 2024 -0400
     4.2+++ b/core/bin/mailman.org	Thu Jun 06 23:15:50 2024 -0400
     4.3@@ -1,5 +1,6 @@
     4.4 #+title: mailman
     4.5 #+author: Richard Westhaver
     4.6+#+setupfile: ../../../clean.theme
     4.7 * help
     4.8 #+begin_src shell :results pp replace
     4.9 mailman -h
     5.1--- a/core/bin/organ.org	Thu Jun 06 00:36:21 2024 -0400
     5.2+++ b/core/bin/organ.org	Thu Jun 06 23:15:50 2024 -0400
     5.3@@ -1,6 +1,6 @@
     5.4 #+title: organ
     5.5 #+author: Richard Westhaver
     5.6-
     5.7+#+setupfile: ../../../clean.theme
     5.8 The =organ= CLI tool is used to manipulate [[https://orgmode.org/][Org Mode]] files.
     5.9 
    5.10 * Overview
     6.1--- a/core/bin/packy.org	Thu Jun 06 00:36:21 2024 -0400
     6.2+++ b/core/bin/packy.org	Thu Jun 06 23:15:50 2024 -0400
     6.3@@ -1,6 +1,6 @@
     6.4 #+title: packy
     6.5 #+author: Richard Westhaver
     6.6-
     6.7+#+setupfile: ../../../clean.theme
     6.8 Packy is a universal package manager. The packy CLI tool is used to
     6.9 query and download resources from local or remote stores.
    6.10 * help
     7.1--- a/core/bin/rdb.org	Thu Jun 06 00:36:21 2024 -0400
     7.2+++ b/core/bin/rdb.org	Thu Jun 06 23:15:50 2024 -0400
     7.3@@ -1,6 +1,6 @@
     7.4 #+title: rdb
     7.5 #+author: Richard Westhaver
     7.6-
     7.7+#+setupfile: ../../../clean.theme
     7.8 The =rdb= cli tool is a simple RocksDB management utility.
     7.9 
    7.10 * help
     8.1--- a/core/bin/readme.org	Thu Jun 06 00:36:21 2024 -0400
     8.2+++ b/core/bin/readme.org	Thu Jun 06 23:15:50 2024 -0400
     8.3@@ -3,6 +3,7 @@
     8.4 #+description: Core Program Docs
     8.5 #+options: ^:nil toc:nil num:nil html-postamble:nil
     8.6 #+export_file_name: index
     8.7+#+setupfile: ../../../clean.theme
     8.8 * [[file:skel.org][skel]]                                                                 :lisp:
     8.9 * [[file:organ.org][organ]]                                                                :lisp:
    8.10 * [[file:packy.org][packy]]                                                                :lisp:
     9.1--- a/core/bin/skel.org	Thu Jun 06 00:36:21 2024 -0400
     9.2+++ b/core/bin/skel.org	Thu Jun 06 23:15:50 2024 -0400
     9.3@@ -1,6 +1,6 @@
     9.4 #+title: skel
     9.5 #+author: Richard Westhaver
     9.6-
     9.7+#+setupfile: ../../../clean.theme
     9.8 The =skel= CLI is the primary build tool for contributors and serves a
     9.9 similar role to language-agnostic build tools like [[https://www.gnu.org/software/make/][GNU Make]], but with
    9.10 the features and ease-of-use of language-specific build tools like
    10.1--- a/core/ffi.org	Thu Jun 06 00:36:21 2024 -0400
    10.2+++ b/core/ffi.org	Thu Jun 06 23:15:50 2024 -0400
    10.3@@ -1,5 +1,6 @@
    10.4 #+title: ffi
    10.5 #+author: Richard Westhaver
    10.6+#+setupfile: ../../clean.theme
    10.7 This doc is about the [[https://en.wikipedia.org/wiki/Foreign_function_interface][Foreign Function Interface]] (FFI) features of the
    10.8 =core=. 
    10.9 
    11.1--- a/core/install.org	Thu Jun 06 00:36:21 2024 -0400
    11.2+++ b/core/install.org	Thu Jun 06 23:15:50 2024 -0400
    11.3@@ -2,6 +2,7 @@
    11.4 #+author: Richard Westhaver
    11.5 #+email: ellis@rwest.io
    11.6 #+property: header-args :dir /home/ellis/comp/core/
    11.7+#+setupfile: ../../clean.theme
    11.8 The core is distributed via our public package registry:
    11.9 [[https://packy.compiler.company][packy.compiler.company]]. You can install any part of the core - from a
   11.10 complete Linux system to individual packages. Refer to the packy
    12.1--- a/core/readme.org	Thu Jun 06 00:36:21 2024 -0400
    12.2+++ b/core/readme.org	Thu Jun 06 23:15:50 2024 -0400
    12.3@@ -1,7 +1,7 @@
    12.4 #+title: docs/core
    12.5 #+author: Richard Westhaver <ellis@rwest.io>
    12.6 #+EXPORT_FILE_NAME: index
    12.7-
    12.8+#+setupfile: ../../clean.theme
    12.9 - [[file:install.org][Install]] :: Install Guide
   12.10 - [[file:tests.org][Tests]] :: Testing Guide
   12.11   - [[https://packy.compiler.company/report/cover/core/cover-index.html][Coverage]] :: Code Coverage Report
    13.1--- a/core/stats.org	Thu Jun 06 00:36:21 2024 -0400
    13.2+++ b/core/stats.org	Thu Jun 06 23:15:50 2024 -0400
    13.3@@ -2,6 +2,7 @@
    13.4 #+title: stats
    13.5 #+author: Richard Westhaver
    13.6 #+property: header-args :dir /home/ellis/comp/core/
    13.7+#+setupfile: ../../clean.theme
    13.8 * vc
    13.9 #+begin_src shell :results pp :exports results
   13.10   hg churn -f "%Y-%m" -s
    14.1--- a/core/tests.org	Thu Jun 06 00:36:21 2024 -0400
    14.2+++ b/core/tests.org	Thu Jun 06 23:15:50 2024 -0400
    14.3@@ -2,6 +2,7 @@
    14.4 #+title: tests
    14.5 #+author: Richard Westhaver
    14.6 #+property: header-args :dir /home/ellis/dev/comp/core/
    14.7+#+setupfile: ../../clean.theme
    14.8 Unit tests are performed on a per-lang basis and described in the
    14.9 sections below. 
   14.10 
    15.1--- a/core/todo.org	Thu Jun 06 00:36:21 2024 -0400
    15.2+++ b/core/todo.org	Thu Jun 06 23:15:50 2024 -0400
    15.3@@ -1,3 +1,7 @@
    15.4+#+title: core/todo
    15.5+#+author: Richard Westhaver
    15.6+#+email: richard.westhaver@gmail.com
    15.7+#+setupfile: ../../clean.theme
    15.8 * DONE migrate to sb-grovel [9/9]                                  :lisp:ffi:
    15.9 :LOGBOOK:
   15.10 - State "TODO"       from              [2023-11-27 Mon 23:42]
    16.1--- a/demo/readme.org	Thu Jun 06 00:36:21 2024 -0400
    16.2+++ b/demo/readme.org	Thu Jun 06 23:15:50 2024 -0400
    16.3@@ -1,5 +1,5 @@
    16.4 #+title: demo
    16.5 #+author: Richard Westhaver
    16.6 #+EXPORT_FILE_NAME: index
    16.7-
    16.8+#+setupfile: ../../clean.theme
    16.9 - [[file:stats.org][Stats]] :: Project Statistics
    17.1--- a/demo/stats.org	Thu Jun 06 00:36:21 2024 -0400
    17.2+++ b/demo/stats.org	Thu Jun 06 23:15:50 2024 -0400
    17.3@@ -1,6 +1,7 @@
    17.4 #+title: stats
    17.5 #+author: Richard Westhaver
    17.6 #+property: header-args :dir /home/ellis/comp/demo/
    17.7+#+setupfile: ../../clean.theme
    17.8 #+begin_src shell :results pp :exports results
    17.9   hg churn -f "%Y-%m" -s
   17.10 #+end_src
    18.1--- a/infra/quickstart.org	Thu Jun 06 00:36:21 2024 -0400
    18.2+++ b/infra/quickstart.org	Thu Jun 06 23:15:50 2024 -0400
    18.3@@ -1,9 +1,9 @@
    18.4-{{{header(infra/quickstart,
    18.5-Richard Westhaver,
    18.6-ellis@rwest.io,
    18.7-Infra Quickstart Guide)}}}
    18.8+#+title: infra/quickstart
    18.9+#+author: Richard Westhaver
   18.10+#+email: ellis@rwest.io
   18.11+#+description: Infra Quickstart Guide
   18.12 #+property: header-args :dir /home/ellis/comp/infra/
   18.13-
   18.14+#+setupfile: ../../clean.theme
   18.15 The CC =infra= project is the CC software deployment toolkit.
   18.16 
   18.17 - *Host Requirements*
    19.1--- a/infra/readme.org	Thu Jun 06 00:36:21 2024 -0400
    19.2+++ b/infra/readme.org	Thu Jun 06 23:15:50 2024 -0400
    19.3@@ -1,6 +1,8 @@
    19.4-{{{header(docs/infra,Richard Westhaver,ellis@rwest.io)}}}
    19.5+#+title: docs/infra
    19.6+#+author: Richard Westhaver
    19.7+#+email: ellis@rwest.io
    19.8 #+EXPORT_FILE_NAME: index
    19.9-
   19.10+#+setupfile: ../../clean.theme
   19.11 The Compiler Company Infrastructure.
   19.12 
   19.13 - [[file:quickstart.org][Quickstart]] :: Quickstart Guide
    20.1--- a/infra/scripts.org	Thu Jun 06 00:36:21 2024 -0400
    20.2+++ b/infra/scripts.org	Thu Jun 06 23:15:50 2024 -0400
    20.3@@ -1,5 +1,7 @@
    20.4-{{{header(infra/scripts,Richard Westhaver,ellis@rwest.io)}}}
    20.5-
    20.6+#+title: infra/scripts
    20.7+#+author: Richard Westhaver
    20.8+#+email: ellis@rwest.io
    20.9+#+setupfile: ../../clean.theme
   20.10 #+begin_src shell :dir /home/ellis/comp/infra/scripts :results list replace :output results
   20.11   ls
   20.12 #+end_src
    21.1--- a/infra/stats.org	Thu Jun 06 00:36:21 2024 -0400
    21.2+++ b/infra/stats.org	Thu Jun 06 23:15:50 2024 -0400
    21.3@@ -2,7 +2,7 @@
    21.4 #+author: Richard Westhaver
    21.5 #+email: ellis@rwest.io
    21.6 #+property: header-args :dir /home/ellis/comp/infra/
    21.7-
    21.8+#+setupfile: ../../clean.theme
    21.9 #+begin_src shell :results pp
   21.10   hg churn -f "%Y-%m" -s
   21.11 #+end_src
    22.1--- a/infra/todo.org	Thu Jun 06 00:36:21 2024 -0400
    22.2+++ b/infra/todo.org	Thu Jun 06 23:15:50 2024 -0400
    22.3@@ -1,3 +1,7 @@
    22.4+#+title: infra/todo
    22.5+#+author: Richard Westhaver
    22.6+#+email: richard.westhaver@gmail.com
    22.7+#+setupfile: ../../clean.theme
    22.8 * TODO deploy [0/3]
    22.9 :LOGBOOK:
   22.10 - State "TODO"       from              [2023-12-30 Sat 19:20]
    23.1--- a/meta/business.org	Thu Jun 06 00:36:21 2024 -0400
    23.2+++ b/meta/business.org	Thu Jun 06 23:15:50 2024 -0400
    23.3@@ -1,8 +1,8 @@
    23.4-{{{header(business,
    23.5-Richard Westhaver,
    23.6-ellis@rwest.io,
    23.7-The Compiler Company Business Model)}}}
    23.8-
    23.9+#+title: business
   23.10+#+author: Richard Westhaver
   23.11+#+email: ellis@rwest.io
   23.12+#+description: The Compiler Company Business Model
   23.13+#+setupfile: ../../clean.theme
   23.14 In short, this document describes the business aspects of The Compiler
   23.15 Company LLC. We are designed to be small, fast, and agile. We
   23.16 infiltrate a market, apply our methodology, and develop solutions that
    24.1--- a/meta/mindset.org	Thu Jun 06 00:36:21 2024 -0400
    24.2+++ b/meta/mindset.org	Thu Jun 06 23:15:50 2024 -0400
    24.3@@ -1,3 +1,4 @@
    24.4 #+title: mindset
    24.5 #+author: Richard Westhaver
    24.6 #+description: A Reflection on the CC Mindset
    24.7+#+setupfile: ../../clean.theme
    25.1--- a/meta/readme.org	Thu Jun 06 00:36:21 2024 -0400
    25.2+++ b/meta/readme.org	Thu Jun 06 23:15:50 2024 -0400
    25.3@@ -1,11 +1,12 @@
    25.4-{{{header(Meta Docs,Richard Westhaver,ellis@rwest.io)}}}
    25.5+#+title: Meta Docs
    25.6+#+author: Richard Westhaver
    25.7+#+email: ellis@rwest.io
    25.8 #+OPTIONS: ^:nil toc:nil num:nil html-postamble:nil
    25.9 #+EXPORT_FILE_NAME: index
   25.10+#+setupfile: ../../clean.theme
   25.11 * [[file:ulang.org][ulang]]
   25.12 * [[file:style.org][style]]
   25.13 * [[file:tech.org][tech]]
   25.14 * [[file:business.org][business]]
   25.15-* [[file:aesthetics.org][aesthetics]]
   25.16 * [[file:mindset.org][mindset]]
   25.17 * [[file:workflows.org][workflows]]
   25.18-* [[file:babel.org][babel]]
    26.1--- a/meta/style.org	Thu Jun 06 00:36:21 2024 -0400
    26.2+++ b/meta/style.org	Thu Jun 06 23:15:50 2024 -0400
    26.3@@ -1,7 +1,7 @@
    26.4 #+title: The Compiler Company Styleguide
    26.5 #+author: Richard Westhaver
    26.6 #+email: ellis@rwest.io
    26.7-
    26.8+#+setupfile: ../../clean.theme
    26.9 As an organization we maintain a styleguide[fn:1] which lists all of
   26.10 the style guidelines we use for our code. If you are contributing to
   26.11 one of our projects, you should review and understand the relevant
    27.1--- a/meta/tech.org	Thu Jun 06 00:36:21 2024 -0400
    27.2+++ b/meta/tech.org	Thu Jun 06 23:15:50 2024 -0400
    27.3@@ -1,7 +1,8 @@
    27.4-{{{header(tech,
    27.5-Richard Westhaver,
    27.6-ellis@rwest.io,
    27.7-The Compiler Company Core Technologies)}}}
    27.8+#+title: tech
    27.9+#+author: Richard Westhaver
   27.10+#+email: ellis@rwest.io
   27.11+#+description: The Compiler Company Core Technologies
   27.12+#+setupfile: ../../clean.theme
   27.13 
   27.14 * OS
   27.15 We primarily support [[https://unix.org][Unix-based]] Operating Systems. Check
    28.1--- a/meta/ulang.org	Thu Jun 06 00:36:21 2024 -0400
    28.2+++ b/meta/ulang.org	Thu Jun 06 23:15:50 2024 -0400
    28.3@@ -2,6 +2,7 @@
    28.4 #+author: Richard Westhaver
    28.5 #+email: ellis@rwest.io
    28.6 #+OPTIONS: toc:t
    28.7+#+setupfile: ../../clean.theme
    28.8 
    28.9 This document describes a *U-Language* as described by the late great
   28.10 [[https://iep.utm.edu/haskell-brooks-curry/][Haskell Curry]]:
    29.1--- a/meta/workflows.org	Thu Jun 06 00:36:21 2024 -0400
    29.2+++ b/meta/workflows.org	Thu Jun 06 23:15:50 2024 -0400
    29.3@@ -1,7 +1,8 @@
    29.4-{{{header(meta/workflows,
    29.5-Richard Westhaver,
    29.6-ellis@rwest.io,
    29.7-Meta Workflows)}}}
    29.8+#+title: meta/workflows
    29.9+#+author: Richard Westhaver
   29.10+#+email: ellis@rwest.io
   29.11+#+description: Meta Workflows
   29.12+#+setupfile: ../../clean.theme
   29.13 
   29.14 * Task Management
   29.15 
    30.1--- a/nas-t/api.org	Thu Jun 06 00:36:21 2024 -0400
    30.2+++ b/nas-t/api.org	Thu Jun 06 23:15:50 2024 -0400
    30.3@@ -1,7 +1,8 @@
    30.4-{{{header(NAS-T API,
    30.5-Richard Westhaver,
    30.6-ellis@rwest.io,
    30.7-NAS-T API Documentation)}}}
    30.8+#+title: NAS-T API
    30.9+#+author: Richard Westhaver
   30.10+#+email: ellis@rwest.io
   30.11+#+description: NAS-T API Documentation
   30.12+#+setupfile: ../../clean.theme
   30.13 * Overview
   30.14 * Protocols
   30.15 * Filesystems
    31.1--- a/nas-t/install.org	Thu Jun 06 00:36:21 2024 -0400
    31.2+++ b/nas-t/install.org	Thu Jun 06 23:15:50 2024 -0400
    31.3@@ -1,7 +1,8 @@
    31.4-{{{header(install,
    31.5-Richard Westhaver,
    31.6-ellis@rwest.io,
    31.7-NAS-T Installation)}}}
    31.8+#+title: install
    31.9+#+author: Richard Westhaver
   31.10+#+email: ellis@rwest.io
   31.11+#+description: NAS-T Installation
   31.12+#+setupfile: ../../clean.theme
   31.13 * Overview
   31.14 #+begin_src sh
   31.15   make build
    32.1--- a/nas-t/notes.org	Thu Jun 06 00:36:21 2024 -0400
    32.2+++ b/nas-t/notes.org	Thu Jun 06 23:15:50 2024 -0400
    32.3@@ -1,7 +1,8 @@
    32.4-{{{header(notes,
    32.5-Richard Westhaver,
    32.6-ellis@rwest.io,
    32.7-NAS-T Notes)}}}
    32.8+#+title: notes
    32.9+#+author: Richard Westhaver
   32.10+#+email: ellis@rwest.io
   32.11+#+description: NAS-T Notes
   32.12+#+setupfile: ../../clean.theme
   32.13 #+BIBLIOGRAPHY: refs.bib
   32.14 * File Systems
   32.15 ** BTRFS
    33.1--- a/nas-t/quickstart.org	Thu Jun 06 00:36:21 2024 -0400
    33.2+++ b/nas-t/quickstart.org	Thu Jun 06 23:15:50 2024 -0400
    33.3@@ -1,7 +1,8 @@
    33.4-{{{header(quickstart,
    33.5-Richard Westhaver,
    33.6-ellis@rwest.io,
    33.7-NAS-T Quickstart)}}}
    33.8+#+title: quickstart
    33.9+#+author: Richard Westhaver
   33.10+#+email: ellis@rwest.io
   33.11+#+description: NAS-T Quickstart
   33.12+#+setupfile: ../../clean.theme
   33.13 * Install
   33.14 * Configure the daemon
   33.15 * Connect a client
    34.1--- a/nas-t/readme.org	Thu Jun 06 00:36:21 2024 -0400
    34.2+++ b/nas-t/readme.org	Thu Jun 06 23:15:50 2024 -0400
    34.3@@ -1,6 +1,9 @@
    34.4-{{{header(docs/NAS-T,Richard Westhaver,ellis@rwest.io,NAS-T Documentation)}}}
    34.5+#+title: docs/NAS-T
    34.6+#+author: Richard Westhaver
    34.7+#+email: ellis@rwest.io
    34.8+#+description: NAS-T Documentation
    34.9 #+EXPORT_FILE_NAME: index
   34.10-
   34.11+#+setupfile: ../../clean.theme
   34.12 Welcome to the documentation home of NAS-T. Choose one of the topics below to get
   34.13 started.
   34.14 
    35.1--- a/nas-t/roadmap.org	Thu Jun 06 00:36:21 2024 -0400
    35.2+++ b/nas-t/roadmap.org	Thu Jun 06 23:15:50 2024 -0400
    35.3@@ -1,8 +1,8 @@
    35.4-{{{header(roadmap,
    35.5-Richard Westhaver,
    35.6-ellis@rwest.io,
    35.7-NAS-T Roadmap)}}}
    35.8-
    35.9+#+title: roadmap
   35.10+#+author: Richard Westhaver
   35.11+#+email: ellis@rwest.io
   35.12+#+description: NAS-T Roadmap
   35.13+#+setupfile: ../../clean.theme
   35.14 * 0.1.0 [0/3]                                                       :current:
   35.15 ** TODO MVP [1/6]
   35.16 :LOGBOOK:
    36.1--- a/nas-t/tutorial.org	Thu Jun 06 00:36:21 2024 -0400
    36.2+++ b/nas-t/tutorial.org	Thu Jun 06 23:15:50 2024 -0400
    36.3@@ -1,7 +1,8 @@
    36.4-{{{header(tutorial,
    36.5-Richard Westhaver,
    36.6-ellis@rwest.io,
    36.7-NAS-T Tutorial)}}}
    36.8+#+title: tutorial
    36.9+#+author: Richard Westhaver
   36.10+#+email: ellis@rwest.io
   36.11+#+description: NAS-T Tutorial
   36.12+#+setupfile: ../../clean.theme
   36.13 * Overview
   36.14 ** Introduction
   36.15 ** The Cloud
    37.1--- a/readme.org	Thu Jun 06 00:36:21 2024 -0400
    37.2+++ b/readme.org	Thu Jun 06 23:15:50 2024 -0400
    37.3@@ -2,6 +2,7 @@
    37.4 #+author: Richard Westhaver
    37.5 #+email: ellis@rwest.io
    37.6 #+description: The Compiler Company Documentation Repository
    37.7+#+setupfile: ../clean.theme
    37.8 #+EXPORT_FILE_NAME: index
    37.9 
   37.10 This project contains the sources for all CC documentation. Choose one