Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
516 commits
Select commit Hold shift + click to select a range
783b197
Name the project on the derive pages
soareschen Nov 8, 2026
23cd7fe
Name the project on the component pages
soareschen Nov 8, 2026
eb69bca
Name the project on the type pages
soareschen Nov 8, 2026
2cbe660
Name the project on the wiring trait pages
soareschen Nov 8, 2026
5aa1d01
Name the project on the field and shape trait pages
soareschen Nov 8, 2026
abb00d0
Name the project on the variant and namespace trait pages
soareschen Nov 8, 2026
9e84541
Keep the tag line to the pages that choose an implementation
soareschen Nov 8, 2026
6857eeb
Name the project on the builder and optional-field trait pages
soareschen Nov 8, 2026
54070da
Name the project on the casting and type-level trait pages
soareschen Nov 8, 2026
9ac6261
Name the project on the formatting and monad trait pages
soareschen Nov 8, 2026
89719db
Show the companions' doc lines and spell out the name first
soareschen Nov 8, 2026
d2bd612
Gloss providers and frame the formatting group exactly
soareschen Nov 8, 2026
2291906
Gloss "CGP component" on the monad trait pages
soareschen Nov 8, 2026
0448b53
Name Context-Generic Programming on the dispatch pages
soareschen Nov 8, 2026
9714c16
Name Context-Generic Programming on the handler and monad pages
soareschen Nov 8, 2026
9cf199f
Name Context-Generic Programming on the error provider pages
soareschen Nov 8, 2026
89507ce
Name Context-Generic Programming on the remaining provider pages
soareschen Nov 8, 2026
a709760
Show the AsRef getter conversion and apply the review revisions
soareschen Nov 8, 2026
dcbd155
Name the project on the comparisons index and order the sidebar
soareschen Nov 8, 2026
38679c5
Name the project on the algebraic effects comparison
soareschen Nov 8, 2026
4d8039a
Name the project on the capabilities comparison
soareschen Nov 8, 2026
bfd63f4
Name the project on the dependency injection comparison
soareschen Nov 8, 2026
3790635
Name the project on the dynamic dispatch comparison
soareschen Nov 8, 2026
13cfa51
Name the project on the implicit parameters comparison
soareschen Nov 8, 2026
b462f53
Name the project on the ML modules comparison
soareschen Nov 8, 2026
9d49cef
Name the project on the policy-based design comparison
soareschen Nov 8, 2026
a6f2d3d
Remove spaces before punctuation after code spans and links
soareschen Nov 8, 2026
ba12620
Name the project on the reflection comparison
soareschen Nov 8, 2026
79918e4
Name the project on the row polymorphism comparison
soareschen Nov 8, 2026
3b397fe
Name the project on the Rust proposals comparison
soareschen Nov 8, 2026
faa7451
Name the project on the type classes comparison
soareschen Nov 8, 2026
8182d6f
Clarify the type-class and row comparison prose
soareschen Nov 8, 2026
dbcfa56
Correct the cgp-examples pages against the release branch
soareschen Nov 8, 2026
d064842
Correct the Hypershell pages against the release branch
soareschen Nov 8, 2026
c073309
Compile the front page's code examples
soareschen Nov 11, 2026
33f0568
Compress the front page's art and add a social card
soareschen Nov 11, 2026
6344442
Rebuild the front page around the code Rust rejects
soareschen Nov 11, 2026
a964ea9
Keep the front page's diagram readable and its provenance exact
soareschen Nov 11, 2026
a7d1e9c
Drop the front page's provenance line and sharpen its copy
soareschen Nov 11, 2026
f3e9792
Lead each front-page paragraph with its point
soareschen Nov 11, 2026
6fb8edf
Tighten the front page's copy in a second point-first pass
soareschen Nov 11, 2026
7b5123b
Rebuild the site's colour theme around the logo's red
soareschen Nov 11, 2026
94df789
Colour the site's code for its palette and highlight every language
soareschen Nov 11, 2026
d6b507a
Self-host the site's heading and code fonts
soareschen Nov 11, 2026
1876bbe
Recolour the shared diagrams and frame images in the dark theme
soareschen Nov 11, 2026
2bc5a5a
Colour the sidebar's scrollbar in Firefox
soareschen Nov 11, 2026
eaa3cae
Soften the announcement bar and the footer text
soareschen Nov 11, 2026
fbd1665
Bring Infima's remaining literal colours into the site theme
soareschen Nov 11, 2026
9c28080
Keep Greek and subscripts in the code font
soareschen Nov 11, 2026
06aa71d
Calm the blog archive's header and the blog list's titles
soareschen Nov 11, 2026
b778431
Document the site theme and add its contrast check
soareschen Nov 11, 2026
fdae1bf
Correct the stated contrast of the logo's red in the dark theme
soareschen Nov 11, 2026
29e6356
Correct the dark theme's comment on the red tints
soareschen Nov 11, 2026
0ff0bc5
Redesign the front page on the site theme
soareschen Nov 11, 2026
144285a
Quote the compiler's E0119 under the front page's rejected block
soareschen Nov 11, 2026
8204eb5
Fix the front page's review findings
soareschen Nov 11, 2026
0c7f306
Stack the front page's code windows below 1240 px
soareschen Nov 11, 2026
3f057ea
Keep section 2's code right after the sentence that introduces it
soareschen Nov 11, 2026
face410
Keep red on the front page for links and actions
soareschen Nov 12, 2026
1c533bc
Turn a front-page card title red on keyboard focus
soareschen Nov 12, 2026
d675671
Set the site in Inter, with semibold headings
soareschen Nov 12, 2026
e836c5c
Set code at weight 500
soareschen Nov 12, 2026
ae38705
Keep bold code bold, and fall back to a real bold face
soareschen Nov 12, 2026
b88e2c1
[front page] Draw the wiring diagram inline and fit the hero at table…
soareschen Nov 12, 2026
44ee4dc
[front page] Merge the feature lists and rewrite the copy in natural …
soareschen Nov 12, 2026
8a5f997
[front page] Clarify two feature cards and check the card text colours
soareschen Nov 12, 2026
3be4fc1
[front page] Set the costs beside their heading
soareschen Nov 12, 2026
83688af
[front page] Show four feature cards
soareschen Nov 12, 2026
a1892c9
[front page] Fold the application section into the coherence section
soareschen Nov 12, 2026
2b2685d
[front page] Even the front page's spacing and section rhythm
soareschen Nov 12, 2026
290f59c
[front page] Name the spacing scale's gaps and correct the caption co…
soareschen Nov 12, 2026
54aeb75
[front page] Set the costs in two columns
soareschen Nov 12, 2026
a4bb908
[front page] Keep the cost section's heading in view while scrolling
soareschen Nov 12, 2026
dcdc96a
[front page] Revise the essay's copy for flow
soareschen Nov 12, 2026
636486a
[front page] Smooth the essay's openings and two leads
soareschen Nov 12, 2026
477aa63
[front page] Name the provider trait and a provider in the hero's block
soareschen Nov 12, 2026
6563b50
[front page] Revise the essay's copy around the encoder example
soareschen Nov 12, 2026
0604eea
Link project source on the default branch
soareschen Nov 13, 2026
246e381
Compile the Overview's examples
soareschen Nov 13, 2026
8323277
State the Quickstart's Rust floor and create its project
soareschen Nov 13, 2026
5092563
Route the Introduction by question, and list the Quickstart
soareschen Nov 13, 2026
f364cdc
Rewrite the Overview as a feature tour with examples
soareschen Nov 13, 2026
4c1ec10
Lay out the Overview's checked wiring one entry per line
soareschen Nov 13, 2026
81eeb64
State the Overview's comparisons with plain Rust fairly
soareschen Nov 13, 2026
07c8a8a
Describe the Overview's problems table as it is
soareschen Nov 13, 2026
c21ff3d
Tighten claims on the Introduction, Quickstart, and Overview
soareschen Nov 13, 2026
f69c3e9
Rewrite the Introduction, Quickstart, and Overview in natural style
soareschen Nov 13, 2026
49b5ddb
Write every website page in natural style by default
soareschen Nov 13, 2026
fb4313d
Show a fair abstract-types example and variants on the Overview
soareschen Nov 13, 2026
9d6b6c1
Qualify claims on the Introduction and the Overview
soareschen Nov 13, 2026
aa8453b
Say the Overview's examples leave out each context's check
soareschen Nov 13, 2026
42c8654
Smooth the Overview's prose in natural style
soareschen Nov 13, 2026
0c46fe3
Tighten the Overview's natural-style prose
soareschen Nov 13, 2026
d146a26
Format the Overview and Quickstart test files
soareschen Nov 13, 2026
88ca440
Move the example-code crate to the 2024 edition
soareschen Nov 13, 2026
da53934
Show only the headline features in code on the Overview
soareschen Nov 13, 2026
38c2cdc
Fold the Introduction's storage example into one clause
soareschen Nov 13, 2026
2a9818b
Ease the Overview's hardest steps for a first-time reader
soareschen Nov 13, 2026
1a4dfb9
Keep the Overview's error-type explanation readable on a phone
soareschen Nov 13, 2026
f0d3418
Smooth the Overview's transitions in natural style
soareschen Nov 13, 2026
6341f33
Mark the contrast in the Overview's zero-cost limit
soareschen Nov 13, 2026
658375a
Darken the dark theme's background and reduce its red
soareschen Nov 13, 2026
165e915
Neutralise the dark note admonitions and table stripes
soareschen Nov 13, 2026
0f5e325
Lead the three docs entry pages with the reader's situation
soareschen Nov 13, 2026
20d0a49
Open the Introduction with the name and the tag line
soareschen Nov 13, 2026
82f3679
Rewrite the Introduction's opening around one trait per type
soareschen Nov 13, 2026
5b97b8b
Connect the Introduction's terms to its opening in natural style
soareschen Nov 13, 2026
9fc8b9e
Mark the Introduction's contrast and name its four terms plainly
soareschen Nov 13, 2026
885f0c6
Require a page's code to say which context shape it is in
soareschen Nov 14, 2026
a6ea79a
Describe the knowledge base's errors without calling it early
soareschen Nov 14, 2026
728d406
Name what the knowledge base's errors refer to
soareschen Nov 14, 2026
ec8d731
Follow the trimmed `cgp::prelude` in pages and example code
soareschen Nov 14, 2026
f87db65
Tighten the pages after the prelude trim
soareschen Nov 14, 2026
77f15ec
Sort the CGP imports the prelude trim added
soareschen Nov 14, 2026
b37d6b7
Import the handler names and `UseContext` the prelude dropped
soareschen Nov 14, 2026
77320a1
Say where `PathCons` and Hypershell's handler names come from
soareschen Nov 14, 2026
b76a2bb
Import the `cgp_field` names the trimmed prelude no longer exports
soareschen Nov 14, 2026
ccdd7ac
Requote the cgp-serde wiring diagnostics from the current tool
soareschen Nov 14, 2026
2810492
Hold every rule for the site's pages in AGENTS.md
soareschen Nov 14, 2026
01abcbd
Describe one AGENTS.md per repository with the writing guides
soareschen Nov 14, 2026
36f6204
Leave the voice readings to the reading map
soareschen Nov 14, 2026
ae758c2
Open each rule section with the point its rules serve
soareschen Nov 14, 2026
1d483b6
List the example and project repositories' AGENTS.md files
soareschen Nov 14, 2026
fd95e84
Describe the provider key derived from the trait's path
soareschen Nov 14, 2026
b0b9b14
Document the provider header's missing component key
soareschen Nov 14, 2026
cb34513
Describe the fix of a derived component's error
soareschen Nov 15, 2026
bb7f2a4
Say when the derived component's note appears
soareschen Nov 15, 2026
b4d492a
Say where an editor applies the missing component's import
soareschen Nov 15, 2026
08fe4cb
Teach importing a component key beside its provider trait
soareschen Nov 15, 2026
d91c114
Qualify the component-key import passage and link it from its neighbours
soareschen Nov 15, 2026
953b12f
Show a fix an editor applies on the reading-output page
soareschen Nov 15, 2026
bcf6d3b
Mirror the program the reading-output page's import fix repairs
soareschen Nov 15, 2026
5ea3d33
Publish the agent skill's component-key import and stated imports
soareschen Nov 15, 2026
c8352a8
Name the conversions the `cgp_fn` and `cgp_auto_getter` pages show
soareschen Nov 15, 2026
2659532
Publish the agent skill's readability fixes
soareschen Nov 15, 2026
b8c0c0b
Rewrite the Contribute page around its routes
soareschen Nov 15, 2026
ccd1ad6
Remove the Hermes SDK link from the acknowledgement
soareschen Nov 15, 2026
8252f38
Let the Contribute page link the knowledge base's issue tracker
soareschen Nov 15, 2026
1c51880
Separate the Contribute page's two reporting routes
soareschen Nov 15, 2026
e81f0b4
Revise the Resources page as an annotated index
soareschen Nov 15, 2026
c77ac27
Name Context-Generic Programming in every page's opening
soareschen Nov 15, 2026
dac9c34
Tighten the Resources entries and three page openings
soareschen Nov 15, 2026
68ac0bd
Label the Contribute page Contribute in the sidebar
soareschen Nov 15, 2026
002d93d
Add a Tooling section and move Reference after Concepts
soareschen Nov 15, 2026
3938245
Link the expand page from the Tooling index
soareschen Nov 15, 2026
8b8c79a
Rewrite the Tooling index in natural style
soareschen Nov 15, 2026
c5c161a
Make Resources a section with a Videos page
soareschen Nov 15, 2026
bbde331
Link cgp's docs.rs entry from the Resources index
soareschen Nov 15, 2026
a2c1387
Give each kind of resource its own section on the Resources index
soareschen Nov 15, 2026
70b0662
Vary the Videos opening and tighten the Resources wording
soareschen Nov 15, 2026
95e8dcd
Rewrite the Resources and Videos pages in natural style
soareschen Nov 15, 2026
ff59be0
Move AI-Assisted Development after Projects in the sidebar
soareschen Nov 15, 2026
e94a81d
Write public-facing documents such as READMEs in natural style
soareschen Nov 15, 2026
c8a598f
Serve the cargo-cgp pages under the Tooling URLs
soareschen Nov 15, 2026
715cdf1
Advance the agent skill to its tooling links
soareschen Nov 15, 2026
f64bf39
Give each agent skill its own directory under the AI section
soareschen Nov 15, 2026
462c8d6
Add a page on installing the CGP skill in each agent
soareschen Nov 15, 2026
dedf702
Advance the skill snapshot to the packaged skill
soareschen Nov 15, 2026
11ab205
Say that installing the skill may need the reader's approval
soareschen Nov 15, 2026
9d0466c
Link the agent skill's site section from Modularity Hierarchy
soareschen Nov 15, 2026
020e707
Tighten the wording of the skills index and installation page
soareschen Nov 15, 2026
9f72cf9
Install the agent skill from main on the skill pages
soareschen Nov 15, 2026
5d008ff
Advance the skill to its version check
soareschen Nov 15, 2026
0f650b0
Wrap the installation page's copy paragraph and advance the skill
soareschen Nov 15, 2026
0a0adbc
Tighten the wording of the skill pages' version sentences
soareschen Nov 15, 2026
b095a70
Revise the AI section's pages in natural style
soareschen Nov 15, 2026
3106f01
Make the point-first-writing skill optional in the agent rules
soareschen Nov 15, 2026
1980ae8
Describe CGP plainly in the AI pages' openings
soareschen Nov 15, 2026
2cf7db2
Revise the writing of the AI section's pages
soareschen Nov 15, 2026
2f3ff33
Smooth the prose of the AI section's pages
soareschen Nov 15, 2026
0211da7
Add an applied tutorial that swaps a storage backend per application
soareschen Nov 15, 2026
6e2e854
Name the idiomatic provider form in the static-dispatch tutorial
soareschen Nov 15, 2026
fd88af7
Give the author's tutorials written front matter and the full name
soareschen Nov 15, 2026
4ee6260
Tighten the tutorial descriptions and link the applied tutorial
soareschen Nov 15, 2026
00a9b79
Smooth the prose of the storage-backend tutorial
soareschen Nov 15, 2026
e1c749d
Cover the remaining v0.8.0 changes in the release post
soareschen Nov 15, 2026
947b438
Update the release post's documentation counts
soareschen Nov 15, 2026
8b34a82
Link the release post's new items and compile their string reads
soareschen Nov 15, 2026
d413fe9
Name Context-Generic Programming in the release post's first line
soareschen Nov 15, 2026
8fcc6a0
Smooth the prose of the release post's additions
soareschen Nov 15, 2026
b55be66
Except release-notes pages from correcting docs in place
soareschen Nov 15, 2026
e6353cf
Add the Release notes category with the v0.8.0 pages
soareschen Nov 15, 2026
5d23df0
Link the v0.8.0 release notes from the release post
soareschen Nov 15, 2026
dd4b397
Name the re-export form of CGP-E041 in the cargo-cgp v0.1.0 notes
soareschen Nov 15, 2026
02feeb6
Correct and complete the v0.8.0 release-notes pages
soareschen Nov 15, 2026
3e78dd8
Revise the writing of the v0.8.0 release-notes pages
soareschen Nov 15, 2026
8b412cf
Add the cgp v0.1.0 release notes
soareschen Nov 15, 2026
5037731
Add the cgp v0.2.0 release notes
soareschen Nov 15, 2026
c181a86
Add the cgp v0.3.0 release notes
soareschen Nov 15, 2026
55c31fe
Revise the writing of the v0.1.0 to v0.3.0 release-notes pages
soareschen Nov 15, 2026
5d68bd6
Add the cgp v0.3.1 release notes
soareschen Nov 15, 2026
aca4eb6
Add the cgp v0.4.0 release notes
soareschen Nov 15, 2026
733d3d6
Add the cgp v0.4.1 release notes
soareschen Nov 15, 2026
45447fd
Add the cgp v0.4.2 release notes
soareschen Nov 15, 2026
9b23703
Correct the UseInputDelegate entry of the cgp v0.4.2 release notes
soareschen Nov 15, 2026
f80d173
Revise the writing of the cgp v0.4.0 and v0.4.2 release notes
soareschen Nov 15, 2026
683d3ff
Correct the unsized-parameter entry of the cgp v0.4.2 release notes
soareschen Nov 15, 2026
b101c87
Add the cgp v0.5.0 release notes
soareschen Nov 15, 2026
24f0416
Add the cgp v0.6.0 release notes
soareschen Nov 15, 2026
063bc2b
List the new prelude exports in the cgp v0.5.0 release notes
soareschen Nov 15, 2026
acfa412
Revise the writing of the cgp v0.5.0 release notes
soareschen Nov 15, 2026
2a59835
Add the cgp v0.6.1 release notes
soareschen Nov 15, 2026
2092dde
Add the cgp v0.7.0 release notes
soareschen Nov 15, 2026
bcf77d7
Add the versioning statement to the release notes index
soareschen Nov 15, 2026
6c89791
Revise the writing of the cgp v0.6.1 and v0.7.0 release notes
soareschen Nov 15, 2026
b3bbc43
Add a Community page to Resources
soareschen Nov 15, 2026
7d58246
Keep only GitHub Sponsors in the sponsorship section
soareschen Nov 15, 2026
809817f
Revise the writing of the Community and Contribute pages
soareschen Nov 15, 2026
5c5ffe7
Name the 2026-11-15 nightly in the cargo-cgp pages
soareschen Nov 16, 2026
a6deaf5
Name the one-thread front end on the cargo-cgp check page
soareschen Nov 16, 2026
a8bb560
State the order the cargo-cgp check prints errors in
soareschen Nov 16, 2026
2dc4b47
Drop the one-thread setting from the cargo-cgp check page
soareschen Nov 16, 2026
9b13bdf
Quote the storage-backend tutorial's report as the check prints it
soareschen Nov 16, 2026
5722d1e
Say which report of the tutorial's mistake cargo-cgp keeps, and why
soareschen Nov 16, 2026
7908df7
Show the storage-backend tutorial's report at its check
soareschen Nov 16, 2026
ad6f5ef
Clarify the order a cargo-cgp check prints its errors in
soareschen Nov 16, 2026
1b92591
Show how to run a cargo-cgp check on one thread
soareschen Nov 16, 2026
9dcf827
Tell a compiler bug from a cargo-cgp one on the troubleshooting page
soareschen Nov 16, 2026
7e948e2
Revise the writing of the one-thread troubleshooting section
soareschen Nov 16, 2026
c3e6af0
Build the snippet suite on Rust 1.100.0
soareschen Nov 16, 2026
2121ea7
Name the removed Greek-letter types and `replace_with!` in the post
soareschen Nov 16, 2026
36eb52e
Name nightly-2026-11-16 as cargo-cgp's pinned toolchain
soareschen Nov 16, 2026
cb83dab
Install cgp-serde and Hypershell from crates.io
soareschen Nov 17, 2026
f1b9f3d
Update the example-code dependencies to their newest compatible versions
soareschen Nov 17, 2026
d5743f4
Add release notes for cgp-serde and Hypershell
soareschen Nov 17, 2026
c5a68fe
Add the cgp-serde v0.3.0 and Hypershell v0.2.0 release notes
soareschen Nov 17, 2026
03ce579
Narrow the cgp-serde v0.1.0 JSON helper's scope
soareschen Nov 17, 2026
64d3eb5
Tighten the cgp-serde and Hypershell release notes
soareschen Nov 17, 2026
b9e1d2d
Replace the email example with synchronous object storage
soareschen Nov 17, 2026
c957263
Make the remaining storage examples synchronous
soareschen Nov 17, 2026
aff5a2e
Revise the wording of the storage examples' prose
soareschen Nov 17, 2026
0881a83
Re-bless the `use_provider` snapshot for the shorter `cgp-macro` doc
soareschen Nov 17, 2026
7c49e84
Retake the release post's documentation counts
soareschen Nov 17, 2026
f0c402a
Align the v0.8.0 post with the release notes and strategy
soareschen Nov 18, 2026
d0a2c67
Smooth the v0.8.0 post's prose
soareschen Nov 18, 2026
17695b6
Make the v0.8.0 post's explanations more concrete
soareschen Nov 18, 2026
ae75aeb
Shorten the front page's coherence section
soareschen Nov 18, 2026
369a7f7
Name CGP in the front page's code caption
soareschen Nov 18, 2026
4da581d
Smooth the front page's feature and cost copy
soareschen Nov 18, 2026
fc74dfb
Rewrite the front page's copy for first-time readers
soareschen Nov 18, 2026
e1249f5
Fix the Concepts diagrams' content and layout
soareschen Nov 18, 2026
901cfae
Put the wiring on the call path in the split diagram
soareschen Nov 18, 2026
e46bb1a
Size the Concepts diagrams' arrowheads to their lines
soareschen Nov 18, 2026
974a76f
Set the Concepts diagrams' code in monospace and trim their margins
soareschen Nov 18, 2026
27cf16e
Give each Concepts page a scope line and tighten its wording
soareschen Nov 18, 2026
aea9740
Revise the Concepts pages' prose for flow
soareschen Nov 18, 2026
54a7dd6
Take cgp 0.8.0 from crates.io in the snippet tests
soareschen Nov 18, 2026
84d8308
Point the skill pages at the skill's current main
soareschen Nov 18, 2026
c74bf8e
Date the v0.8.0 post and release notes to the release
soareschen Nov 18, 2026
62b3924
Date the cgp-serde and Hypershell release notes to the release
soareschen Nov 18, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
23 changes: 21 additions & 2 deletions .github/workflows/deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,35 @@ on:
# Review gh actions docs if you want to further define triggers, paths, etc
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on

# Serialize deployments instead of cancelling them: a cancelled deploy can leave
# the Pages environment half-updated, so a newer run waits for the current one.
concurrency:
group: pages
cancel-in-progress: false

permissions:
contents: read

# To minimize supply-chain exposure this workflow uses only GitHub's own
# first-party actions. The site is built here and published from `main`; every
# other branch and every pull request is built by `test-deploy.yaml`.
jobs:
build:
name: Build Docusaurus
runs-on: ubuntu-latest
timeout-minutes: 20
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
# The skill pages under docs/ai/skills/ are symlinks into the
# cgp-skills submodule; without it the build fails on missing files.
submodules: recursive
- uses: actions/setup-node@v4
with:
node-version: 20
# `.nvmrc` pins the runtime so a Node release cannot change the build
# without a commit.
node-version-file: .nvmrc
cache: npm

- name: Install dependencies
Expand Down Expand Up @@ -45,7 +63,8 @@ jobs:
url: ${{ steps.deployment.outputs.page_url }}

runs-on: ubuntu-latest
timeout-minutes: 10
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
uses: actions/deploy-pages@v4
64 changes: 56 additions & 8 deletions .github/workflows/test-deploy.yaml
Original file line number Diff line number Diff line change
@@ -1,26 +1,74 @@
name: Test deployment

# `main` is built by `deploy.yaml`, which also publishes it, so this workflow
# builds every other branch and every pull request instead of duplicating that
# build.

# Review gh actions docs if you want to further define triggers, paths, etc
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
on:
pull_request:
branches:
push:
branches-ignore:
- main
# Review gh actions docs if you want to further define triggers, paths, etc
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
pull_request: {}

# Cancel in-progress runs when a new commit is pushed to the same PR, branch, or tag.
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true

permissions:
contents: read

# To minimize supply-chain exposure this workflow uses only GitHub's own
# first-party actions. Each job runs a check the repository's documentation
# lists: the site build from README.md, and the snippet tests from
# example-code/README.md.
jobs:
test-deploy:
name: Test deployment
build:
name: Build the site
runs-on: ubuntu-latest
timeout-minutes: 20
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
# The skill pages under docs/ai/skills/ are symlinks into the
# cgp-skills submodule; without it the build fails on missing files.
submodules: recursive
- uses: actions/setup-node@v4
with:
node-version: 20
# `.nvmrc` pins the runtime so a Node release cannot change the build
# without a commit.
node-version-file: .nvmrc
cache: npm

- name: Install dependencies
run: npm ci
- name: Test build website
run: npm run build
run: npm run build

example-code:
name: Snippet tests
runs-on: ubuntu-latest
timeout-minutes: 30
env:
CARGO_TERM_COLOR: always
steps:
# `example-code` takes `cgp` from crates.io, so the website is the only
# checkout.
- name: Check out the website
uses: actions/checkout@v4
with:
path: contextgeneric.dev
# `example-code/rust-toolchain.toml` pins the compiler the snapshots are
# blessed with; rustup installs that channel from this directory.
- name: Install the pinned Rust toolchain
working-directory: contextgeneric.dev/example-code
run: rustup toolchain install
# The pages' snippets are compiled here, so a page cannot drift from the
# library without a red build. The compile-fail snapshots are skipped
# here; run them locally with `cargo test`.
- name: Run the snippet tests
working-directory: contextgeneric.dev/example-code
run: cargo test -- --skip rejected_snippets_do_not_compile
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "cgp-skills"]
path = cgp-skills
url = https://github.com/contextgeneric/cgp-skills.git
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
24.22.2
159 changes: 159 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,159 @@
# AGENTS.md: the CGP website

Follow these rules for every change to this repository. Read the knowledge base's
[website section](https://github.com/contextgeneric/cgp-knowledge-base/blob/main/website/README.md)
before writing, from the checkout at `../cgp-knowledge-base`, or on GitHub when it is absent.

## Universal rules

These rules hold in every CGP repository. The
[knowledge base's AGENTS.md](https://github.com/contextgeneric/cgp-knowledge-base/blob/main/AGENTS.md)
holds their canonical wording: read it first, and change a rule there before updating this block:

- Learn CGP and its tools from the `/cgp` skill and the knowledge base; never restate them in this
file.
- Prefer the local sibling checkout when reading another project.
- Write a cross-project link as a GitHub URL on `main`.
- Name official release versions only, never a pre-release.
- Commit only when the user explicitly asks, on the current branch.
- Verify a claim against the source before writing it.
- Keep every view of the same truth in sync in the same change.
- Ask the user when a decision is ambiguous.
- Apply point-first writing to internal prose, and natural writing to public-facing documents
such as READMEs, using the optional `/point-first-writing` skill when it is available.

## Task guides

Each kind of task has a guide in the knowledge base's `website/` section. Read it before the task:

- **Writing or revising a page:** the page kind's guide in `writing-guides/`, with the shared set
and the page kind's row of its
[reading map](https://github.com/contextgeneric/cgp-knowledge-base/blob/main/website/writing-guides/README.md#the-reading-map),
and the page's record.
- **Adding or moving a page, or writing a blog post:** `writing-guides/README.md` and
`information-architecture.md`.
- **Changing the theme or a page's styles:** `visual-design.md`.
- **Changing the build, the navigation, or the `example-code` crate:** `site.md` and
[example-code/README.md](example-code/README.md).

## Public prose

Every page follows the communication strategy's claims, name, and style, and the author reads the
pages that carry the argument:

- Read the knowledge base's `communication-strategy/message.md` whenever a page makes a claim about
what CGP is good for, satisfying its pain, strength, objection, and boundary, and read any strategy
document whole when the page makes a claim its reading-map row does not cover.
- Name Context-Generic Programming in each page's prose and relate a short form of the tag line to
its content, following the knowledge base's
[naming rule](https://github.com/contextgeneric/cgp-knowledge-base/blob/main/communication-strategy/identity.md#the-name-and-the-tag-line-on-every-page);
the skill pages and the published blog posts are exempt.
- Never publish an invented benchmark, adoption figure, or quotation.
- Never disparage another crate, language, or community; say where a simpler tool is the better choice.
- Concede the learning curve, the verbose diagnostics, and the young ecosystem where a reader looks for
them.
- Write every page in natural-writing's natural style by default, the front page and every page under
`docs/` included; follow a page kind's writing guide where it names another style.
- Let agents draft the pages, and have the author read in full before publication the pages the
knowledge base's
[AI disclosure policy](https://github.com/contextgeneric/cgp-knowledge-base/blob/main/communication-strategy/ai-disclosure.md#the-two-claims-that-are-easiest-to-get-wrong)
lists; ship everything else on its guide plus a spot check, and flag a judgement call for the
author's reading rather than deciding alone.
- Add one provenance line at the foot of each page written or substantially rewritten, linking the
section of the AI disclosure page that matches how it was made, and record the level in the page's
record; leave the front page without one, add none to an existing page unless the author asks, and
add none to a scaffolded stub.

## Code

Every snippet on a page is verified against current CGP:

- Invoke the `/cgp` skill before writing CGP code, and verify every snippet against the current `cgp`
release, the `cgp` source, or its tests.
- Prefer code already verified in the knowledge base's `examples/` directory, and the idioms its
guides teach.
- Say which context shape a page's code is in, with the qualifiers the knowledge base's
`vocabulary.md` defines; an introductory page may record the shape in its record instead.
- Never take current syntax from an existing blog post; read the post's record for its stale parts
first, and use the knowledge base's `releases/` directory to date an unfamiliar construct.
- Put a page's code in the `example-code/` crate, one module per heading, except a Projects page,
whose code is checked against the project's repository; do not mirror the knowledge base's own
snippets there.
- Run the `example-code` tests after changing a page's code, as
[example-code/README.md](example-code/README.md) describes.
- Fill an elided body with a comment saying so, write a rejected snippet as a compile-fail fixture,
and prefer duplication between files over a shared helper neither page shows.
- Treat a page without an `example-code` file as unvisited, not unverified, and check generated code
with `cargo cgp expand`, which the crate does not replace.

## Links

A published page links only public resources, and links into the knowledge base only through the
exceptions below:

- Never link a published page into the knowledge base.
- Make only three hand-written exceptions: `docs/ai/disclaimer.md`, which may link the base's
repository page and its issue tracker; `docs/contribute.md`, which may link the issue tracker
alone; and the pages under `docs/ai/knowledge-base/`, which may also link the four top-level entry
files (`README.md`, `summary.md`, `AGENTS.md`, and `sibling-projects.md`) and name a section's
directory in prose rather than link a document inside it.
- Let only the published skill pages under `docs/ai/skills/` cite the knowledge base by deep GitHub
URL; nobody hand-writes them, and another page must not link there.
- Do not correct these links or extend the exception to another page.
- Link only public resources: other pages on this site, the `cgp` repository and its siblings,
docs.rs, crates.io, and ordinary external sources.

## Legacy resources

The site presents only current resources:

- Do not link, list, or recommend the CGP Patterns book or the Hermes SDK, or direct a page to
present either.
- Point a reader who wants a first-principles explanation or a real system at this site's Concepts and
Projects pages instead.
- Leave the book's record, the project history, and the blog records that mention them as they are.
- Leave an acknowledgement of where CGP came from to the author, and raise a page that already
mentions a legacy resource with the author.

## The agent skill

The skill pages are a published snapshot of `cgp-skills`, which is the only place to change them:

- Do not edit the symlinks under `docs/ai/skills/`; correct the skill in `cgp-skills`.
- Leave the `cgp-skills` submodule pointer to the author.
- Read the `../cgp-skills` checkout for what the skill says, and treat a lagging published snapshot
as normal: it is not a defect and does not need an issue, note, or fix.

## Blog posts

A published post is a dated artifact, so a correction goes beside it rather than into it:

- Do not rewrite a published post; it is a dated artifact, edited only when its record says it was
published unfinished.
- Annotate a misleading post, supersede it with a new one, or record the drift in its record, as the
author decides; record the drift by default for release posts.
- Never change a published post's `slug`, and never rewrite a snippet in it.
- Correct a page under `docs/` in place, without a changelog note, except a page under
`docs/release-notes/`: it is dated like a post, so correct it only where it misstates its own
release, and record a later change on the later release's page.

## Build

The site stays a stock Docusaurus build that fails on a broken link or anchor:

- Build and serve the site with the commands in [README.md](README.md), and check the build's exit
status rather than its output.
- Keep `onBrokenLinks` and `onBrokenAnchors` set to `throw`; fix every reference when a page or heading
moves.
- Take a page's position from `sidebar_position` and its directory's `_category_.json`.
- Update the announcement bar in `docusaurus.config.ts` by hand with every release announcement.
- Keep the site stock: do not add plugins, and do not add React beyond the landing page.
- Use the theme's tokens from `src/css/custom.css` in page styles, never a hex colour.
- Treat `notes/` as working material, not site content; do not edit or copy from it.

## Knowledge base

Each page has a record in the knowledge base that changes with it:

- Add or revise the page's knowledge-base record in the same change.
- State what needs updating in the knowledge base when its checkout is absent.
Loading
Loading