Skip to content

Commit 1515e09

Browse files
Cleanup docs (#126)
Fix minor typos and inconsistencies
1 parent acc08f3 commit 1515e09

File tree

3 files changed

+9
-16
lines changed

3 files changed

+9
-16
lines changed

docs/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ <h2>What is STEF?</h2>
2929
<h2>Key Features</h2>
3030
<ul>
3131
<li>Schema-driven binary format.</li>
32-
<li>Support for primitive and composite data types.</li>
32+
<li>Support for primitive, composite and recursive data types.</li>
3333
<li>Columnar encoding, small payloads.</li>
3434
<li>Fast serialization and deserialization.</li>
3535
<li>Extensible schema support.</li>
3636
<li>Network protocol with forward and backward interoperability of schema.</li>
37-
<li>Open specification and reference implementations in Go and Java</li>
37+
<li>Open specification and reference implementations in Go and Java.</li>
3838
</ul>
3939
<a class="button" href="./benchmarks.html">View Benchmarks</a>
4040

docs/sdl.html

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ <h3>Root Structs</h3>
7777
Timestamp uint64
7878
Span Span
7979
}</code></pre>
80-
<p>When multiple root structs are defined, each record in the stream will be one of the root types, and the STEF format includes type information to distinguish between them during deserialization.</p>
80+
<p>When multiple root structs are defined, each record in the stream will be one of the root types.</p>
8181

8282
<h3>Dictionary Compression</h3>
8383
<p>Fields can use dictionary compression for repeated values using the <code>dict</code> modifier:</p>
@@ -100,7 +100,7 @@ <h3>Dictionary Compression</h3>
100100
ServiceName string dict(ServiceNames) // Same dictionary as above
101101
SpanName string dict(SpanNames)
102102
}</code></pre>
103-
<p>This sharing enables more efficient compression when the same values appear across different record types.</p>
103+
<p>This sharing enables more efficient compression when the same values appear across different structs.</p>
104104

105105
<h3>Optional Fields</h3>
106106
<p>Fields can be marked as optional, meaning they may not be present in every record:</p>
@@ -117,7 +117,6 @@ <h2>Arrays</h2>
117117
Numbers []int64
118118
Objects []Person
119119
}</code></pre>
120-
<p>Arrays are variable-length - they can be empty or contain any number of elements.</p>
121120

122121
<h2>Oneofs (Union Types)</h2>
123122
<p>Oneofs define union types that can hold one of several possible field types:</p>
@@ -150,7 +149,7 @@ <h2>Enums</h2>
150149
Histogram = 2
151150
Summary = 3
152151
}</code></pre>
153-
<p>Enum values must be explicitly assigned unsigned integer values. Multiple number formats are supported:</p>
152+
<p>Enum values must be explicitly assigned unsigned integer values in the 0..2^64-1 range. Multiple number formats are supported:</p>
154153
<ul>
155154
<li><strong>Decimal:</strong> <code>MetricType = 42</code></li>
156155
<li><strong>Hexadecimal:</strong> <code>MetricType = 0x2A</code> or <code>MetricType = 0X2A</code></li>

docs/stefgen.html

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -82,21 +82,15 @@ <h3>Generate Java Code (Simple)</h3>
8282
<pre><code class="language-bash"># Generate Java code with tests in same directory
8383
stefgen -lang=java -outdir=./java-gen schema.stef</code></pre>
8484

85-
<h2>Supported Languages</h2>
86-
<ul>
87-
<li><strong>Go</strong> - Generates Go structs with serialization methods</li>
88-
<li><strong>Java</strong> - Generates Java classes with serialization support</li>
89-
</ul>
90-
9185
<h2>Generated Code Structure</h2>
9286

9387
<p>stefgen creates:</p>
9488
<ul>
9589
<li>Struct, oneof and multimap definitions matching your STEF schema</li>
9690
<li>Type-safe accessors for all fields</li>
97-
<li>Reader for deserialization</li>
98-
<li>Writer for serialization</li>
99-
<li>Read/write unit tests with randomized inputs, matching the schema</li>
91+
<li>Reader for deserialization for every root struct</li>
92+
<li>Writer for serialization for every root struct</li>
93+
<li>Read/write unit tests with randomized inputs</li>
10094
</ul>
10195

10296
<h2>Example Workflow</h2>
@@ -134,7 +128,7 @@ <h3>3. Use Generated Code</h3>
134128
// Flush the stream to the buffer.
135129
writer.Flush()</code></pre>
136130

137-
<p class="footer-note">For more information about STEF schema syntax and features, see the <a href="https://github.com/splunk/stef/blob/main/stef-spec/specification.md">STEF Specification</a>.</p>
131+
<p class="footer-note">For more information about STEF schema syntax and features, see the <a href="sdl.html">STEF Schema Definition Language</a>.</p>
138132
</main>
139133
<script src="https://cdn.jsdelivr.net/npm/[email protected]/prism.js"></script>
140134
<script src="https://cdn.jsdelivr.net/npm/[email protected]/components/prism-go.min.js"></script>

0 commit comments

Comments
 (0)