Skip to content

Commit 9fe690e

Browse files
josealekhinejosealekhine
committed
docs: rename audit-conventions to Code Conventions, reorder in nav
Rename title from "Audit Conventions" to "Code Conventions" for contributor discoverability. Add frontmatter with icon. Move nav position to right after Invariants. Spec: specs/superpowers-analysis.md Signed-off-by: Jose Alekhinne <jose@ctx.ist>
1 parent e6d8088 commit 9fe690e

112 files changed

Lines changed: 2289 additions & 2059 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/reference/audit-conventions.md‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,15 @@
1-
# Audit Conventions: Common Patterns and Fixes
1+
---
2+
# / ctx: https://ctx.ist
3+
# ,'`./ do you remember?
4+
# `.,'\
5+
# \ Copyright 2026-present Context contributors.
6+
# SPDX-License-Identifier: Apache-2.0
7+
8+
title: Code Conventions
9+
icon: lucide/scroll-text
10+
---
11+
12+
# Code Conventions: Common Patterns and Fixes
213

314
This guide documents the code conventions enforced by `internal/audit/`
415
AST tests. Each section shows the violation pattern, the fix, and the

‎docs/reference/index.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,13 @@ and contributors.
1717

1818
---
1919

20+
### [Code Conventions](audit-conventions.md)
21+
22+
Common patterns and fixes for the AST compliance tests in
23+
`internal/audit/`. When a test fails, find the matching section.
24+
25+
---
26+
2027
### [CLI](../cli/index.md)
2128

2229
Every command, subcommand, and flag.
@@ -52,13 +59,6 @@ sensitive values that travel with the project.
5259

5360
---
5461

55-
### [Audit Conventions](audit-conventions.md)
56-
57-
Common patterns and fixes for the AST compliance tests in
58-
`internal/audit/`. When a test fails, find the matching section.
59-
60-
---
61-
6262
### [Version History](versions.md)
6363

6464
Changelog for every `ctx` release.

‎site/404.html‎

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2916,16 +2916,16 @@
29162916

29172917

29182918
<li class="md-nav__item">
2919-
<a href="/reference/skills/" class="md-nav__link">
2919+
<a href="/reference/audit-conventions/" class="md-nav__link">
29202920

29212921

29222922

2923-
<svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-sparkles" viewBox="0 0 24 24"><path d="M11.017 2.814a1 1 0 0 1 1.966 0l1.051 5.558a2 2 0 0 0 1.594 1.594l5.558 1.051a1 1 0 0 1 0 1.966l-5.558 1.051a2 2 0 0 0-1.594 1.594l-1.051 5.558a1 1 0 0 1-1.966 0l-1.051-5.558a2 2 0 0 0-1.594-1.594l-5.558-1.051a1 1 0 0 1 0-1.966l5.558-1.051a2 2 0 0 0 1.594-1.594zM20 2v4M22 4h-4"/><circle cx="4" cy="20" r="2"/></svg>
2923+
<svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-scroll-text" viewBox="0 0 24 24"><path d="M15 12h-5M15 8h-5M19 17V5a2 2 0 0 0-2-2H4"/><path d="M8 21h12a2 2 0 0 0 2-2v-1a1 1 0 0 0-1-1H11a1 1 0 0 0-1 1v1a2 2 0 1 1-4 0V5a2 2 0 1 0-4 0v2a1 1 0 0 0 1 1h3"/></svg>
29242924

29252925
<span class="md-ellipsis">
29262926

29272927

2928-
Skills
2928+
Code Conventions
29292929

29302930

29312931

@@ -2946,16 +2946,16 @@
29462946

29472947

29482948
<li class="md-nav__item">
2949-
<a href="/reference/comparison/" class="md-nav__link">
2949+
<a href="/reference/skills/" class="md-nav__link">
29502950

29512951

29522952

2953-
<svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-git-compare" viewBox="0 0 24 24"><circle cx="18" cy="18" r="3"/><circle cx="6" cy="6" r="3"/><path d="M13 6h3a2 2 0 0 1 2 2v7M11 18H8a2 2 0 0 1-2-2V9"/></svg>
2953+
<svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-sparkles" viewBox="0 0 24 24"><path d="M11.017 2.814a1 1 0 0 1 1.966 0l1.051 5.558a2 2 0 0 0 1.594 1.594l5.558 1.051a1 1 0 0 1 0 1.966l-5.558 1.051a2 2 0 0 0-1.594 1.594l-1.051 5.558a1 1 0 0 1-1.966 0l-1.051-5.558a2 2 0 0 0-1.594-1.594l-5.558-1.051a1 1 0 0 1 0-1.966l5.558-1.051a2 2 0 0 0 1.594-1.594zM20 2v4M22 4h-4"/><circle cx="4" cy="20" r="2"/></svg>
29542954

29552955
<span class="md-ellipsis">
29562956

29572957

2958-
Tool Ecosystem
2958+
Skills
29592959

29602960

29612961

@@ -2976,16 +2976,16 @@
29762976

29772977

29782978
<li class="md-nav__item">
2979-
<a href="/reference/session-journal/" class="md-nav__link">
2979+
<a href="/reference/comparison/" class="md-nav__link">
29802980

29812981

29822982

2983-
<svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-book-open" viewBox="0 0 24 24"><path d="M12 7v14M3 18a1 1 0 0 1-1-1V4a1 1 0 0 1 1-1h5a4 4 0 0 1 4 4 4 4 0 0 1 4-4h5a1 1 0 0 1 1 1v13a1 1 0 0 1-1 1h-6a3 3 0 0 0-3 3 3 3 0 0 0-3-3z"/></svg>
2983+
<svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-git-compare" viewBox="0 0 24 24"><circle cx="18" cy="18" r="3"/><circle cx="6" cy="6" r="3"/><path d="M13 6h3a2 2 0 0 1 2 2v7M11 18H8a2 2 0 0 1-2-2V9"/></svg>
29842984

29852985
<span class="md-ellipsis">
29862986

29872987

2988-
Session Journal
2988+
Tool Ecosystem
29892989

29902990

29912991

@@ -3006,16 +3006,16 @@
30063006

30073007

30083008
<li class="md-nav__item">
3009-
<a href="/reference/scratchpad/" class="md-nav__link">
3009+
<a href="/reference/session-journal/" class="md-nav__link">
30103010

30113011

30123012

3013-
<svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-sticky-note" viewBox="0 0 24 24"><path d="M21 9a2.4 2.4 0 0 0-.706-1.706l-3.588-3.588A2.4 2.4 0 0 0 15 3H5a2 2 0 0 0-2 2v14a2 2 0 0 0 2 2h14a2 2 0 0 0 2-2z"/><path d="M15 3v5a1 1 0 0 0 1 1h5"/></svg>
3013+
<svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-book-open" viewBox="0 0 24 24"><path d="M12 7v14M3 18a1 1 0 0 1-1-1V4a1 1 0 0 1 1-1h5a4 4 0 0 1 4 4 4 4 0 0 1 4-4h5a1 1 0 0 1 1 1v13a1 1 0 0 1-1 1h-6a3 3 0 0 0-3 3 3 3 0 0 0-3-3z"/></svg>
30143014

30153015
<span class="md-ellipsis">
30163016

30173017

3018-
Scratchpad
3018+
Session Journal
30193019

30203020

30213021

@@ -3036,16 +3036,16 @@
30363036

30373037

30383038
<li class="md-nav__item">
3039-
<a href="/reference/versions/" class="md-nav__link">
3039+
<a href="/reference/scratchpad/" class="md-nav__link">
30403040

30413041

30423042

3043-
<svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-history" viewBox="0 0 24 24"><path d="M3 12a9 9 0 1 0 9-9 9.75 9.75 0 0 0-6.74 2.74L3 8"/><path d="M3 3v5h5M12 7v5l4 2"/></svg>
3043+
<svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-sticky-note" viewBox="0 0 24 24"><path d="M21 9a2.4 2.4 0 0 0-.706-1.706l-3.588-3.588A2.4 2.4 0 0 0 15 3H5a2 2 0 0 0-2 2v14a2 2 0 0 0 2 2h14a2 2 0 0 0 2-2z"/><path d="M15 3v5a1 1 0 0 0 1 1h5"/></svg>
30443044

30453045
<span class="md-ellipsis">
30463046

30473047

3048-
Version History
3048+
Scratchpad
30493049

30503050

30513051

@@ -3066,14 +3066,16 @@
30663066

30673067

30683068
<li class="md-nav__item">
3069-
<a href="/reference/audit-conventions/" class="md-nav__link">
3069+
<a href="/reference/versions/" class="md-nav__link">
30703070

30713071

30723072

3073+
<svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-history" viewBox="0 0 24 24"><path d="M3 12a9 9 0 1 0 9-9 9.75 9.75 0 0 0-6.74 2.74L3 8"/><path d="M3 3v5h5M12 7v5l4 2"/></svg>
3074+
30733075
<span class="md-ellipsis">
30743076

30753077

3076-
Audit Conventions: Common Patterns and Fixes
3078+
Version History
30773079

30783080

30793081

‎site/blog/2026-01-27-building-ctx-using-ctx/index.html‎

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2923,16 +2923,16 @@
29232923

29242924

29252925
<li class="md-nav__item">
2926-
<a href="../../reference/skills/" class="md-nav__link">
2926+
<a href="../../reference/audit-conventions/" class="md-nav__link">
29272927

29282928

29292929

2930-
<svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-sparkles" viewBox="0 0 24 24"><path d="M11.017 2.814a1 1 0 0 1 1.966 0l1.051 5.558a2 2 0 0 0 1.594 1.594l5.558 1.051a1 1 0 0 1 0 1.966l-5.558 1.051a2 2 0 0 0-1.594 1.594l-1.051 5.558a1 1 0 0 1-1.966 0l-1.051-5.558a2 2 0 0 0-1.594-1.594l-5.558-1.051a1 1 0 0 1 0-1.966l5.558-1.051a2 2 0 0 0 1.594-1.594zM20 2v4M22 4h-4"/><circle cx="4" cy="20" r="2"/></svg>
2930+
<svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-scroll-text" viewBox="0 0 24 24"><path d="M15 12h-5M15 8h-5M19 17V5a2 2 0 0 0-2-2H4"/><path d="M8 21h12a2 2 0 0 0 2-2v-1a1 1 0 0 0-1-1H11a1 1 0 0 0-1 1v1a2 2 0 1 1-4 0V5a2 2 0 1 0-4 0v2a1 1 0 0 0 1 1h3"/></svg>
29312931

29322932
<span class="md-ellipsis">
29332933

29342934

2935-
Skills
2935+
Code Conventions
29362936

29372937

29382938

@@ -2953,16 +2953,16 @@
29532953

29542954

29552955
<li class="md-nav__item">
2956-
<a href="../../reference/comparison/" class="md-nav__link">
2956+
<a href="../../reference/skills/" class="md-nav__link">
29572957

29582958

29592959

2960-
<svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-git-compare" viewBox="0 0 24 24"><circle cx="18" cy="18" r="3"/><circle cx="6" cy="6" r="3"/><path d="M13 6h3a2 2 0 0 1 2 2v7M11 18H8a2 2 0 0 1-2-2V9"/></svg>
2960+
<svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-sparkles" viewBox="0 0 24 24"><path d="M11.017 2.814a1 1 0 0 1 1.966 0l1.051 5.558a2 2 0 0 0 1.594 1.594l5.558 1.051a1 1 0 0 1 0 1.966l-5.558 1.051a2 2 0 0 0-1.594 1.594l-1.051 5.558a1 1 0 0 1-1.966 0l-1.051-5.558a2 2 0 0 0-1.594-1.594l-5.558-1.051a1 1 0 0 1 0-1.966l5.558-1.051a2 2 0 0 0 1.594-1.594zM20 2v4M22 4h-4"/><circle cx="4" cy="20" r="2"/></svg>
29612961

29622962
<span class="md-ellipsis">
29632963

29642964

2965-
Tool Ecosystem
2965+
Skills
29662966

29672967

29682968

@@ -2983,16 +2983,16 @@
29832983

29842984

29852985
<li class="md-nav__item">
2986-
<a href="../../reference/session-journal/" class="md-nav__link">
2986+
<a href="../../reference/comparison/" class="md-nav__link">
29872987

29882988

29892989

2990-
<svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-book-open" viewBox="0 0 24 24"><path d="M12 7v14M3 18a1 1 0 0 1-1-1V4a1 1 0 0 1 1-1h5a4 4 0 0 1 4 4 4 4 0 0 1 4-4h5a1 1 0 0 1 1 1v13a1 1 0 0 1-1 1h-6a3 3 0 0 0-3 3 3 3 0 0 0-3-3z"/></svg>
2990+
<svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-git-compare" viewBox="0 0 24 24"><circle cx="18" cy="18" r="3"/><circle cx="6" cy="6" r="3"/><path d="M13 6h3a2 2 0 0 1 2 2v7M11 18H8a2 2 0 0 1-2-2V9"/></svg>
29912991

29922992
<span class="md-ellipsis">
29932993

29942994

2995-
Session Journal
2995+
Tool Ecosystem
29962996

29972997

29982998

@@ -3013,16 +3013,16 @@
30133013

30143014

30153015
<li class="md-nav__item">
3016-
<a href="../../reference/scratchpad/" class="md-nav__link">
3016+
<a href="../../reference/session-journal/" class="md-nav__link">
30173017

30183018

30193019

3020-
<svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-sticky-note" viewBox="0 0 24 24"><path d="M21 9a2.4 2.4 0 0 0-.706-1.706l-3.588-3.588A2.4 2.4 0 0 0 15 3H5a2 2 0 0 0-2 2v14a2 2 0 0 0 2 2h14a2 2 0 0 0 2-2z"/><path d="M15 3v5a1 1 0 0 0 1 1h5"/></svg>
3020+
<svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-book-open" viewBox="0 0 24 24"><path d="M12 7v14M3 18a1 1 0 0 1-1-1V4a1 1 0 0 1 1-1h5a4 4 0 0 1 4 4 4 4 0 0 1 4-4h5a1 1 0 0 1 1 1v13a1 1 0 0 1-1 1h-6a3 3 0 0 0-3 3 3 3 0 0 0-3-3z"/></svg>
30213021

30223022
<span class="md-ellipsis">
30233023

30243024

3025-
Scratchpad
3025+
Session Journal
30263026

30273027

30283028

@@ -3043,16 +3043,16 @@
30433043

30443044

30453045
<li class="md-nav__item">
3046-
<a href="../../reference/versions/" class="md-nav__link">
3046+
<a href="../../reference/scratchpad/" class="md-nav__link">
30473047

30483048

30493049

3050-
<svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-history" viewBox="0 0 24 24"><path d="M3 12a9 9 0 1 0 9-9 9.75 9.75 0 0 0-6.74 2.74L3 8"/><path d="M3 3v5h5M12 7v5l4 2"/></svg>
3050+
<svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-sticky-note" viewBox="0 0 24 24"><path d="M21 9a2.4 2.4 0 0 0-.706-1.706l-3.588-3.588A2.4 2.4 0 0 0 15 3H5a2 2 0 0 0-2 2v14a2 2 0 0 0 2 2h14a2 2 0 0 0 2-2z"/><path d="M15 3v5a1 1 0 0 0 1 1h5"/></svg>
30513051

30523052
<span class="md-ellipsis">
30533053

30543054

3055-
Version History
3055+
Scratchpad
30563056

30573057

30583058

@@ -3073,14 +3073,16 @@
30733073

30743074

30753075
<li class="md-nav__item">
3076-
<a href="../../reference/audit-conventions/" class="md-nav__link">
3076+
<a href="../../reference/versions/" class="md-nav__link">
30773077

30783078

30793079

3080+
<svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-history" viewBox="0 0 24 24"><path d="M3 12a9 9 0 1 0 9-9 9.75 9.75 0 0 0-6.74 2.74L3 8"/><path d="M3 3v5h5M12 7v5l4 2"/></svg>
3081+
30803082
<span class="md-ellipsis">
30813083

30823084

3083-
Audit Conventions: Common Patterns and Fixes
3085+
Version History
30843086

30853087

30863088

0 commit comments

Comments
 (0)