Commit `c12be9354a`

c12be9354a2051f788a26764aa284b6937a0f15d

parent: 2f14a20767

Verified · cmc

cmc <hello@cleberg.net> · 2026-08-11 21:47 UTC

Prepare the repository for publication

- **0BSD** rather than MIT, matching the other repositories here. Same
  permission with the attribution requirement dropped — strictly more
  permissive, so relaxing it before anyone has the old terms costs nothing.
- **CODEOWNERS**, in the shape devianter and skunky-art use.
- **A Pages workflow** for the documentation site. It is fifteen org files built
  by the tool that documents them, so the deploy doubles as the most honest
  smoke test here: if orgo cannot build its own docs, this fails. `--strict`
  means a broken internal link fails it too, which is precisely how
  documentation rots.
- `repository` and `homepage` in Cargo.toml point somewhere, since there is
  finally somewhere to point.

The docs job builds with the release profile, so a break in that profile
surfaces on a push rather than at a tag.

Layout: unified · split

.github/workflows/docs.yml added +75

@@ -0,0 +1,75 @@
	1	name: Docs
	2
	3	# Publish the documentation site to GitHub Pages.
	4	#
	5	# The site is fifteen org files under docs/, built by the tool they document — so this
	6	# job is also the most honest smoke test in the repository: if orgo cannot build its own
	7	# documentation, the deploy fails and says so.
	8	#
	9	# `--strict` makes a broken internal link a build failure. Docs rot by having their links
	10	# quietly stop resolving, and that is exactly the failure a static site generator is
	11	# supposed to be able to catch.
	12
	13	on:
	14	push:
	15	branches: [main]
	16	# Templates and the config shape the pages as much as the prose does, and a change to
	17	# the renderer changes every page. Anything else — a test, a fixture — cannot.
	18	paths:
	19	- "docs/**"
	20	- "src/**"
	21	- "Cargo.toml"
	22	- "Cargo.lock"
	23	- ".github/workflows/docs.yml"
	24	workflow_dispatch:
	25
	26	# Read the repository, write a Pages deployment. Nothing else.
	27	permissions:
	28	contents: read
	29	pages: write
	30	id-token: write
	31
	32	# One deployment at a time, and let a newer commit win: a queue of doc builds racing each
	33	# other to publish is worse than the last one arriving late.
	34	concurrency:
	35	group: pages
	36	cancel-in-progress: true
	37
	38	jobs:
	39	build:
	40	runs-on: ubuntu-latest
	41	steps:
	42	- name: Checkout
	43	uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
	44
	45	- name: Install Rust
	46	uses: dtolnay/rust-toolchain@1ff72ee08e3cb84d84adba594e0a297990fc1ed3 # stable
	47	with:
	48	toolchain: stable
	49
	50	- name: Cache cargo
	51	uses: Swatinem/rust-cache@98c8021b550208e191a6a3145459bfc9fb29c4c0 # v2.8.0
	52
	53	- name: Configure Pages
	54	uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0
	55
	56	# Built with the release profile: the docs deploy is also the only place a release
	57	# build runs outside a tag, so a break in it surfaces here rather than at release.
	58	- name: Build the site
	59	run: cargo run --release --locked -- build docs -o docs/_site --strict
	60
	61	- name: Upload the artifact
	62	uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v3.0.1
	63	with:
	64	path: docs/_site
	65
	66	deploy:
	67	needs: build
	68	runs-on: ubuntu-latest
	69	environment:
	70	name: github-pages
	71	url: ${{ steps.deployment.outputs.page_url }}
	72	steps:
	73	- name: Deploy
	74	id: deployment
	75	uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5

CODEOWNERS added +1

	@@ -0,0 +1 @@
		1	* @ccleberg

LICENSE +12 −21

	@@ -1,21 +1,12 @@
1	MIT License	1	Copyright (C) 2026 krazy warez
2		2
3	Copyright (c) 2026 Christian Cleberg	3	Permission to use, copy, modify, and/or distribute this software for any
4		4	purpose with or without fee is hereby granted.
5	Permission is hereby granted, free of charge, to any person obtaining a copy	5
6	of this software and associated documentation files (the "Software"), to deal	6	THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
7	in the Software without restriction, including without limitation the rights	7	WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
8	to use, copy, modify, merge, publish, distribute, sublicense, and/or sell	8	MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
9	copies of the Software, and to permit persons to whom the Software is	9	ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
10	furnished to do so, subject to the following conditions:	10	WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
11		11	ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
12	The above copyright notice and this permission notice shall be included in all	12	OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
13	copies or substantial portions of the Software.
14
15	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16	IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18	AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19	LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20	OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21	SOFTWARE.

Commit c12be9354a

Commit `c12be9354a`