Skip to main content

Colophon

This document records how the reference is produced and the rules it is held to.

Editorial rules​

The reference is a living document, revised in place. It is not chronological, and entries carry no publication date; the last revision date is shown at the foot of each page and the full history is in the repository.

Entries are organised by subject. Language revisions (C++20, C++23, C++26) appear as compatibility metadata on the pages they affect, never as top-level structure. A page about constexpr records which revisions relaxed its restrictions; there is no page about C++23.

Prose is expository, not instructional. Second-person address, exhortation and conversational asides are not used. Claims about cost are stated with the cost model in force; claims about performance are stated with the machine, compiler, flags and method that produced them, or they are not stated at all.

Each technical entry is expected to develop its subject through the same sequence: definition, motivation, formal statement, C++ representation, implementation, complexity, performance considerations, limitations, related entries, references. Short entries may compress the sequence but do not reorder it.

Toolchain​

ComponentChoice
Site generatorDocusaurus 3, TypeScript configuration
Content formatMDX 3 with front matter
MathematicsKaTeX via remark-math and rehype-katex
DiagramsMermaid, rendered at build time
CodePrism with an extended C++ grammar, square-set blocks
HostingGitHub Pages, deployed by GitHub Actions from main

Mathematics is written in LaTeX inside MDX. Display equations use $$ … $$; inline mathematics uses $ … $. Notation is defined where it is introduced, and the shared conventions are collected in Conventions.

Typography​

RoleFace
Prose and headingsSource Serif 4
Interface, tables, captionsIBM Plex Sans
Code and quantitiesJetBrains Mono

The measure is held near 66 characters. Section numbers are generated, not typed, and are mirrored in the table of contents. Rules are used in place of boxes and shadows; the palette is a single ink on a single ground, with one restrained link colour.

Code​

Examples are written to compile as shown against a conforming implementation at the revision stated on the page, with -std=c++20 or later as indicated. Identifiers follow the mathematics they encode: A, x, b in a linear solve, Ring and VectorSpace for structures, descriptive names elsewhere. Toy names are not used, comments are used only where the code cannot state the intent itself, and includes are shown when the example is meant to be compiled rather than read.

Benchmark code is reported with the exact command line, the compiler version, the CPU model and the measurement procedure. Results without that context are not published.

Citation​

Standard-library and language behaviour is cited by clause where precision requires it, and by working paper (for example P1907R1) where the point at issue is the evolution of a feature. Numerical results cite the primary literature. Secondary sources are cited only where they are the clearest available statement.

Licence​

Prose is available under CC BY 4.0. Code examples are available under the MIT licence. Corrections and disputes over technical claims are welcome as repository issues; a claim that cannot be defended is withdrawn rather than qualified.