WIP: Expanded documentation (inc. @gteege's manual) #334
Commits on Oct 7, 2020
-
docs: Import Gunnar Teege's manual (hence
gtm') intodoc/'.Most of the transformation was done automatically with a gnarly mess of Emacs-Lisp, and was cleaned up a bit (especially the custom TeX macros) by hand. This is a temporary location --- I'll be working on folding this into the rest of the manual, copy-editing, etc. [skip ci][skip lemma]
-
docs: Restructure into two major parts: introduction and reference.
The 'introduction' expands the 'getting started' documentation, a quick installation reference, and the first programs. The 'reference' is intended to combines the previous (proto-reference) documentation with Gunnar Teege's manual, expanding and clarifying them. [skip ci][skip lemma]
-
docs: Use the documentation tree's symlink. (SQUASH ^^)
[skip ci][skip lemma]
-
docs: Promote the \chapter's to \part's in the LaTeX docs. (SQUASH ^{4})
[skip ci][skip lemma]
-
docs: Mark the appendices for the LaTeX output. (SQUASH ^{5})
[skip ci][skip lemma]
-
docs: Rearrange the "introduction" section. (SQUASH ^{6})
Split up the old 'getting started' page; the examples can be fleshed out some more and cleaned up, which is on the todo list. [skip ci][skip lemma]
-
docs: Shuffle the syntax documents; fix broken references. (SQUASH ^{7})
[skip ci][skip lemma]
-
docs: README to reST; add some structured project info (SQUASH ^{8})
[skip ci][skip lemma]
-
docs: intro/install: point at the full installation instructions (SQU…
…ASH ^{10}) [skip ci][skip lemma] -
docs: `preamble' has been teased apart. (SQUASH ^{11})
[skip ci][skip lemma]
-
docs: Extract @gteege's "this is not a tutorial" wording. (SQUASH ^{12})
[skip ci][skip lemma]
-
docs: ref/syntax: merge @gteege's syntax docs in as surface syntax. (…
…SQUASH ^{13}) [skip ci][skip lemma] -
docs: ref/core: Import liamoc fig 3.1. (SQUASH ^{13})
[skip ci][skip lemma]
-
docs: Use the magic
|cogent|macro. (SQUASH ^{14})[skip ci][skip lemma]
-
docs: ref/values: intro, patterns (SQUASH ^{15})
[skip ci][skip lemma]
-
docs: ref/compiler: Clean up sectioning. (SQUASH ^{16})
[skip ci][skip lemma]
-
docs: appx/todo: Do something with all those `.todo's floating around…
…. (SQUASH ^{17}) [skip ci][skip lemma] -
docs: Use the small-caps Cogent runes more often. (SQUASH ^{18})
[skip ci][skip lemma]
-
docs: ref/types: Style cleanup; spelling, grammar. (SQUASH ^{19})
[skip ci][skip lemma]
-
docs: intro/first-program: working through content. (SQUASH ^{21})
[skip ci][skip lemma]
-
docs: intro/first-program: Expand the Cogent introduction more. (SQUA…
…SH ^{22}) A gentle, step-wise introduction to the `add' function unfolds, where we build up the language's capabilities piecewise. Instead of diving into a polymorphic type definition, let's start with a very simple function, and build from there. [skip ci][skip lemma] -
docs: intro/first-program: Fix the branches; promote a par. (SQUASH ^…
…{23}) [skip ci][skip lemma] -
docs: intro/first-program: Gentler introduction to AqC.
[skip ci][skip lemma]
-
docs: reference/surface-syntax: note identifier moves.
[skip ci][skip lemma]
-
docs: introduction/first-program: Clean up some language.
[skip ci][skip lemma]
-
docs: Move the Antiquoted C documentation out of the way.
[skip ci][skip lemma]
-
docs: A first draft of a first draft of new AqC docs.
Based on discussions with Peter Chubb, some of my own experiments to clarify behaviours, and presented here for first review. Much, much more work is needed, of course. [skip ci][skip lemma]
-
docs: reference/antiquoted-c: Expand some of the description.
Includes changes derived from feedback from Louis Cheung -- thanks!
