Skip to content
This repository was archived by the owner on Jun 18, 2026. It is now read-only.

Commit d21a942

Browse files
docs: fix typos, normalize STYX → Styx, fix boolean examples
- Fix 'the the colon' duplicate word - Fix 'Does it confusing?' → 'Does it get confusing?' - Fix 'paylod' → 'payload' - Fix '/it/' → '_it_' (markdown italics) - Fix 'age: number' → 'age: u32' (Rust type) - Fix 'look like as styx' → 'look in Styx' - Fix schema.md rule reference: r[key.equality] → r[entry.key-equality] - Normalize STYX → Styx throughout (it's not an acronym) - Fix claude-skill.md: booleans are bare scalars (true/false), not tags - Remove incorrect 'built-in tags' section from skill
1 parent 5bb13d3 commit d21a942

35 files changed

Lines changed: 196 additions & 47 deletions

docs/content/_index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Imagine JSON
1818
```
1919

2020
But you remove everything that's getting in the way: the double quotes, the
21-
the colon, even the comma:
21+
colon, even the comma:
2222

2323
```styx
2424
{
@@ -75,7 +75,7 @@ In static typing flavor, you may for example deserialize to:
7575
#[derive(Facet)]
7676
struct Does {
7777
name: String,
78-
age: number,
78+
age: u32,
7979
retired: bool,
8080
}
8181
```
@@ -146,7 +146,7 @@ sparse_seq (1 2 @ 8 9)
146146
And in fact, wanna know a secret? `@` is not even the canonical form
147147
of unit: `@@` is.
148148

149-
An empty tag degenerates to `@`, and a tag without a paylod defaults to
149+
An empty tag degenerates to `@`, and a tag without a payload defaults to
150150
a payload of `@`.
151151

152152
Therefore:
@@ -171,7 +171,7 @@ Spaces separate seq elements or key-value pairs in object context:
171171
@tag() // key(tag=tag, payload=()) value(tag=@, payload=@)
172172
```
173173

174-
Does it confusing? Maybe. Little bit.
174+
Does it get confusing? Maybe. Little bit.
175175

176176
## Styx the objective
177177

@@ -209,7 +209,7 @@ one last bit of nesting? As a treat? You can use object attribute syntax:
209209
}
210210
```
211211

212-
And that's /it/ with the weirdness. (Don't worry, there are comprehensive
212+
And that's _it_ with the weirdness. (Don't worry, there are comprehensive
213213
specifications and test suites).
214214

215215
Some unfamiliar bits, but hopefully not too many, which lets us...
@@ -299,5 +299,5 @@ Styx has first-class support for [Zed](https://zed.dev) with syntax highlighting
299299
- [Parser Spec](/spec/parser) — Formal syntax rules
300300
- [Schema Spec](/spec/schema) — Type system and validation
301301
- [Diagnostics](/spec/diagnostics) — Error message standards
302-
- [Rust Bindings](/bindings/rust) — How Rust types map to STYX
302+
- [Rust Bindings](/bindings/rust) — How Rust types map to Styx
303303
- [Comparisons](/comparisons) — vs JSON, YAML, TOML, KDL

docs/content/bindings/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ sort_by = "weight"
55
insert_anchor_links = "heading"
66
+++
77

8-
Language bindings for STYX.
8+
Language bindings for Styx.

docs/content/bindings/rust.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ slug = "rust"
55
insert_anchor_links = "heading"
66
+++
77

8-
How Rust types map to STYX syntax. Examples use [facet](https://github.com/facet-rs/facet) derives.
8+
How Rust types map to Styx syntax. Examples use [facet](https://github.com/facet-rs/facet) derives.
99

1010
## Implicit root object
1111

12-
STYX documents are implicitly objects. When parsing, the top-level content is wrapped in an implicit root object. This means you cannot parse a bare tagged value directly into an enum — you need a wrapper struct.
12+
Styx documents are implicitly objects. When parsing, the top-level content is wrapped in an implicit root object. This means you cannot parse a bare tagged value directly into an enum — you need a wrapper struct.
1313

1414
```compare
1515
/// rust

docs/content/comparisons/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sort_by = "weight"
55
insert_anchor_links = "heading"
66
+++
77

8-
How STYX compares to other configuration formats.
8+
How Styx compares to other configuration formats.
99

1010
- [JSON](/comparisons/json) — the lingua franca of data interchange
1111
- [YAML](/comparisons/yaml) — the most common human-authored config format

docs/content/comparisons/json.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ slug = "json"
55
insert_anchor_links = "heading"
66
+++
77

8-
JSON is the lingua franca of data interchange. STYX is designed for human authoring,
8+
JSON is the lingua franca of data interchange. Styx is designed for human authoring,
99
not machine interchange, which leads to different trade-offs.
1010

1111
## Simple object
@@ -98,7 +98,7 @@ count 42
9898
label 42
9999
```
100100

101-
In STYX, both are the scalar `42`. The deserializer interprets based on target type.
101+
In Styx, both are the scalar `42`. The deserializer interprets based on target type.
102102

103103
## Attribute syntax
104104

docs/content/comparisons/toml.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ slug = "toml"
55
insert_anchor_links = "heading"
66
+++
77

8-
TOML is popular for Rust project configuration (Cargo.toml). STYX offers
8+
TOML is popular for Rust project configuration (Cargo.toml). Styx offers
99
different trade-offs for deeply nested structures.
1010

1111
## Simple object
@@ -74,7 +74,7 @@ point = { x = 1, y = 2 }
7474
point {x 1, y 2}
7575
```
7676

77-
TOML 1.1 allows multi-line inline tables with trailing commas. STYX comma-separated objects must be single-line.
77+
TOML 1.1 allows multi-line inline tables with trailing commas. Styx comma-separated objects must be single-line.
7878

7979
## Reopening sections
8080

@@ -98,4 +98,4 @@ database {
9898
}
9999
```
100100

101-
TOML allows reopening sections. In STYX, each key appears exactly once.
101+
TOML allows reopening sections. In Styx, each key appears exactly once.

docs/content/comparisons/yaml.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ slug = "yaml"
55
insert_anchor_links = "heading"
66
+++
77

8-
YAML is the most common human-authored configuration format. STYX addresses several
8+
YAML is the most common human-authored configuration format. Styx addresses several
99
YAML pain points while preserving readability.
1010

1111
## Simple object
@@ -77,7 +77,7 @@ countries:
7777
countries (GB NO IE)
7878
```
7979

80-
In STYX, `NO` is always the text `NO`. The deserializer interprets based on target type.
80+
In Styx, `NO` is always the text `NO`. The deserializer interprets based on target type.
8181

8282
## Kubernetes-style config
8383

@@ -128,7 +128,7 @@ server {
128128
}
129129
```
130130

131-
YAML's indentation can cause subtle bugs. STYX structure is always explicit.
131+
YAML's indentation can cause subtle bugs. Styx structure is always explicit.
132132

133133
## Anchors and aliases
134134

@@ -152,4 +152,4 @@ production {
152152
}
153153
```
154154

155-
STYX does not support references. Use application-level merging instead.
155+
Styx does not support references. Use application-level merging instead.

docs/content/examples/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ sort_by = "weight"
55
insert_anchor_links = "heading"
66
+++
77

8-
Examples of how some documents would look like as styx
8+
Examples of how some documents would look in Styx
99

1010
* [Kubernetes deployment](k8s.md)

docs/content/examples/k8s.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ slug = "k8s"
55
insert_anchor_links = "heading"
66
+++
77

8-
A Kubernetes Deployment in YAML vs STYX.
8+
A Kubernetes Deployment in YAML vs Styx.
99

1010
```compare
1111
/// yaml

docs/content/guide/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ sort_by = "weight"
55
insert_anchor_links = "heading"
66
+++
77

8-
Practical guides for using STYX.
8+
Practical guides for using Styx.

0 commit comments

Comments
 (0)