Cleanup docs

[tigrannajaryan]

Fix minor typos and inconsistencies

[Copilot]

Pull Request Overview

This PR fixes minor typos and inconsistencies in the documentation HTML files. The changes improve clarity and accuracy of the documentation content.

• Remove redundant "Supported Languages" section from stefgen.html
• Update content descriptions to be more precise and accurate
• Fix grammar and punctuation issues
• Update link reference to point to internal SDL documentation

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File	Description
docs/stefgen.html	Remove redundant languages section, improve content descriptions, and update footer link
docs/sdl.html	Fix grammar issues and improve technical accuracy of descriptions
docs/index.html	Add missing punctuation and improve feature description accuracy

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[github-actions]

Benchmark Result

Benchmark diff with base branch

goos: linux
goarch: amd64
pkg: github.com/splunk/stef/benchmarks
cpu: AMD EPYC 7763 64-Core Processor                
                                                 │ bench-main.txt │           bench-new.txt            │
                                                 │     sec/op     │    sec/op     vs base              │
SerializeNative/STEF/none-4                          12.23m ± 12%   11.97m ± 10%       ~ (p=0.394 n=6)
SerializeNative/STEFU/none-4                         42.76m ±  2%   42.42m ±  3%       ~ (p=0.394 n=6)
DeserializeNative/STEF/none-4                        2.868m ±  1%   2.860m ±  1%       ~ (p=0.394 n=6)
DeserializeNative/STEFU/none-4                       11.73m ±  2%   11.76m ±  2%       ~ (p=0.699 n=6)
SerializeFromPdata/STEF/none-4                       213.2m ±  8%   205.5m ±  2%       ~ (p=0.065 n=6)
SerializeFromPdata/STEFU/none-4                      42.63m ±  1%   43.11m ±  2%       ~ (p=0.240 n=6)
DeserializeToPdata/STEF/none-4                       43.93m ±  2%   43.19m ±  3%       ~ (p=0.093 n=6)
DeserializeToPdata/STEFU/none-4                      67.69m ±  0%   68.27m ±  2%  +0.85% (p=0.002 n=6)
STEFReaderRead-4                                     2.868m ±  1%   2.887m ±  1%       ~ (p=0.132 n=6)
STEFSerializeMultipart/astronomy-otelmetrics-4        3.684 ± 11%    3.765 ± 14%       ~ (p=0.132 n=6)
STEFDeserializeMultipart/astronomy-otelmetrics-4     91.16m ±  2%   90.50m ± 11%       ~ (p=0.699 n=6)
ReadSTEF-4                                           2.900m ±  1%   2.885m ±  1%       ~ (p=0.132 n=6)
ReadSTEFZ-4                                          4.676m ±  1%   4.477m ±  5%  -4.26% (p=0.026 n=6)
ReadSTEFZWriteSTEF-4                                 8.902m ±  1%   9.625m ±  3%  +8.11% (p=0.002 n=6)
geomean                                              25.72m         25.69m        -0.10%

                                                 │ bench-main.txt │           bench-new.txt            │
                                                 │   sec/point    │  sec/point    vs base              │
SerializeNative/STEF/none-4                          183.0n ± 12%   179.0n ± 11%       ~ (p=0.394 n=6)
SerializeNative/STEFU/none-4                         639.6n ±  2%   634.4n ±  3%       ~ (p=0.368 n=6)
DeserializeNative/STEF/none-4                        42.89n ±  1%   42.76n ±  1%       ~ (p=0.361 n=6)
DeserializeNative/STEFU/none-4                       175.4n ±  2%   175.9n ±  2%       ~ (p=0.725 n=6)
SerializeFromPdata/STEF/none-4                       3.189µ ±  8%   3.072µ ±  2%  -3.65% (p=0.045 n=6)
SerializeFromPdata/STEFU/none-4                      637.5n ±  1%   644.6n ±  2%       ~ (p=0.240 n=6)
DeserializeToPdata/STEF/none-4                       657.1n ±  2%   645.8n ±  3%       ~ (p=0.093 n=6)
DeserializeToPdata/STEFU/none-4                      1.012µ ±  0%   1.020µ ±  2%  +0.84% (p=0.002 n=6)
STEFReaderRead-4                                     42.90n ±  1%   43.17n ±  1%       ~ (p=0.132 n=6)
STEFSerializeMultipart/astronomy-otelmetrics-4       4.683µ ± 11%   4.785µ ± 14%       ~ (p=0.132 n=6)
STEFDeserializeMultipart/astronomy-otelmetrics-4     115.8n ±  2%   115.1n ± 11%       ~ (p=0.699 n=6)
ReadSTEF-4                                           43.40n ±  1%   43.18n ±  1%       ~ (p=0.121 n=6)
ReadSTEFZ-4                                          69.98n ±  1%   67.01n ±  5%  -4.25% (p=0.026 n=6)
ReadSTEFZWriteSTEF-4                                 133.2n ±  1%   144.0n ±  3%  +8.07% (p=0.002 n=6)
geomean                                              270.5n         270.2n        -0.11%

                                                 │ bench-main.txt │           bench-new.txt            │
                                                 │      B/op      │     B/op      vs base              │
SerializeNative/STEF/none-4                          3.479Mi ± 0%   3.478Mi ± 0%       ~ (p=1.000 n=6)
SerializeNative/STEFU/none-4                         6.952Mi ± 0%   6.952Mi ± 0%  -0.00% (p=0.009 n=6)
DeserializeNative/STEF/none-4                        842.3Ki ± 0%   842.3Ki ± 0%       ~ (p=0.455 n=6)
DeserializeNative/STEFU/none-4                       1.466Mi ± 0%   1.466Mi ± 0%       ~ (p=1.000 n=6)
SerializeFromPdata/STEF/none-4                       143.3Mi ± 0%   143.3Mi ± 0%       ~ (p=0.485 n=6)
SerializeFromPdata/STEFU/none-4                      6.952Mi ± 0%   6.952Mi ± 0%       ~ (p=0.394 n=6)
DeserializeToPdata/STEF/none-4                       29.82Mi ± 0%   29.82Mi ± 0%       ~ (p=0.846 n=6)
DeserializeToPdata/STEFU/none-4                      36.53Mi ± 0%   36.53Mi ± 0%       ~ (p=0.810 n=6)
STEFReaderRead-4                                     842.3Ki ± 0%   842.3Ki ± 0%       ~ (p=0.455 n=6)
STEFSerializeMultipart/astronomy-otelmetrics-4       3.717Gi ± 0%   3.716Gi ± 0%       ~ (p=0.699 n=6)
STEFDeserializeMultipart/astronomy-otelmetrics-4     20.17Mi ± 0%   20.17Mi ± 0%       ~ (p=0.844 n=6)
ReadSTEF-4                                           842.3Ki ± 0%   842.3Ki ± 0%       ~ (p=1.000 n=6)
ReadSTEFZ-4                                          10.12Mi ± 0%   10.12Mi ± 0%       ~ (p=0.699 n=6)
ReadSTEFZWriteSTEF-4                                 13.45Mi ± 0%   13.45Mi ± 0%       ~ (p=0.310 n=6)
geomean                                              10.59Mi        10.59Mi       -0.00%

                                                 │ bench-main.txt │            bench-new.txt            │
                                                 │   allocs/op    │  allocs/op   vs base                │
SerializeNative/STEF/none-4                           2.929k ± 0%   2.927k ± 0%       ~ (p=0.983 n=6)
SerializeNative/STEFU/none-4                          1.102k ± 0%   1.101k ± 0%  -0.09% (p=0.015 n=6)
DeserializeNative/STEF/none-4                         1.342k ± 0%   1.342k ± 0%       ~ (p=1.000 n=6) ¹
DeserializeNative/STEFU/none-4                        1.403k ± 0%   1.403k ± 0%       ~ (p=1.000 n=6) ¹
SerializeFromPdata/STEF/none-4                        256.4k ± 0%   256.4k ± 0%       ~ (p=0.502 n=6)
SerializeFromPdata/STEFU/none-4                       1.101k ± 0%   1.102k ± 0%       ~ (p=0.121 n=6)
DeserializeToPdata/STEF/none-4                        623.4k ± 0%   623.4k ± 0%       ~ (p=1.000 n=6) ¹
DeserializeToPdata/STEFU/none-4                       812.2k ± 0%   812.2k ± 0%       ~ (p=1.000 n=6) ¹
STEFReaderRead-4                                      1.342k ± 0%   1.342k ± 0%       ~ (p=1.000 n=6) ¹
STEFSerializeMultipart/astronomy-otelmetrics-4        14.44M ± 0%   14.44M ± 0%       ~ (p=0.240 n=6)
STEFDeserializeMultipart/astronomy-otelmetrics-4      8.402k ± 0%   8.402k ± 0%       ~ (p=1.000 n=6) ¹
ReadSTEF-4                                            1.342k ± 0%   1.342k ± 0%       ~ (p=1.000 n=6) ¹
ReadSTEFZ-4                                           1.375k ± 0%   1.375k ± 0%       ~ (p=1.000 n=6) ¹
ReadSTEFZWriteSTEF-4                                  2.376k ± 0%   2.376k ± 0%       ~ (p=1.000 n=6)
geomean                                               11.39k        11.39k       -0.01%
¹ all samples are equal

Benchmark result

benchstat bench-new.txt
goos: linux
goarch: amd64
pkg: github.com/splunk/stef/benchmarks
cpu: AMD EPYC 7763 64-Core Processor                
                                                 │ bench-new.txt │
                                                 │    sec/op     │
SerializeNative/STEF/none-4                         11.97m ± 10%
SerializeNative/STEFU/none-4                        42.42m ±  3%
DeserializeNative/STEF/none-4                       2.860m ±  1%
DeserializeNative/STEFU/none-4                      11.76m ±  2%
SerializeFromPdata/STEF/none-4                      205.5m ±  2%
SerializeFromPdata/STEFU/none-4                     43.11m ±  2%
DeserializeToPdata/STEF/none-4                      43.19m ±  3%
DeserializeToPdata/STEFU/none-4                     68.27m ±  2%
STEFReaderRead-4                                    2.887m ±  1%
STEFSerializeMultipart/astronomy-otelmetrics-4       3.765 ± 14%
STEFDeserializeMultipart/astronomy-otelmetrics-4    90.50m ± 11%
ReadSTEF-4                                          2.885m ±  1%
ReadSTEFZ-4                                         4.477m ±  5%
ReadSTEFZWriteSTEF-4                                9.625m ±  3%
geomean                                             25.69m

                                                 │ bench-new.txt │
                                                 │   sec/point   │
SerializeNative/STEF/none-4                         179.0n ± 11%
SerializeNative/STEFU/none-4                        634.4n ±  3%
DeserializeNative/STEF/none-4                       42.76n ±  1%
DeserializeNative/STEFU/none-4                      175.9n ±  2%
SerializeFromPdata/STEF/none-4                      3.072µ ±  2%
SerializeFromPdata/STEFU/none-4                     644.6n ±  2%
DeserializeToPdata/STEF/none-4                      645.8n ±  3%
DeserializeToPdata/STEFU/none-4                     1.020µ ±  2%
STEFReaderRead-4                                    43.17n ±  1%
STEFSerializeMultipart/astronomy-otelmetrics-4      4.785µ ± 14%
STEFDeserializeMultipart/astronomy-otelmetrics-4    115.1n ± 11%
ReadSTEF-4                                          43.18n ±  1%
ReadSTEFZ-4                                         67.01n ±  5%
ReadSTEFZWriteSTEF-4                                144.0n ±  3%
geomean                                             270.2n

                                                 │ bench-new.txt │
                                                 │     B/op      │
SerializeNative/STEF/none-4                         3.478Mi ± 0%
SerializeNative/STEFU/none-4                        6.952Mi ± 0%
DeserializeNative/STEF/none-4                       842.3Ki ± 0%
DeserializeNative/STEFU/none-4                      1.466Mi ± 0%
SerializeFromPdata/STEF/none-4                      143.3Mi ± 0%
SerializeFromPdata/STEFU/none-4                     6.952Mi ± 0%
DeserializeToPdata/STEF/none-4                      29.82Mi ± 0%
DeserializeToPdata/STEFU/none-4                     36.53Mi ± 0%
STEFReaderRead-4                                    842.3Ki ± 0%
STEFSerializeMultipart/astronomy-otelmetrics-4      3.716Gi ± 0%
STEFDeserializeMultipart/astronomy-otelmetrics-4    20.17Mi ± 0%
ReadSTEF-4                                          842.3Ki ± 0%
ReadSTEFZ-4                                         10.12Mi ± 0%
ReadSTEFZWriteSTEF-4                                13.45Mi ± 0%
geomean                                             10.59Mi

                                                 │ bench-new.txt │
                                                 │   allocs/op   │
SerializeNative/STEF/none-4                          2.927k ± 0%
SerializeNative/STEFU/none-4                         1.101k ± 0%
DeserializeNative/STEF/none-4                        1.342k ± 0%
DeserializeNative/STEFU/none-4                       1.403k ± 0%
SerializeFromPdata/STEF/none-4                       256.4k ± 0%
SerializeFromPdata/STEFU/none-4                      1.102k ± 0%
DeserializeToPdata/STEF/none-4                       623.4k ± 0%
DeserializeToPdata/STEFU/none-4                      812.2k ± 0%
STEFReaderRead-4                                     1.342k ± 0%
STEFSerializeMultipart/astronomy-otelmetrics-4       14.44M ± 0%
STEFDeserializeMultipart/astronomy-otelmetrics-4     8.402k ± 0%
ReadSTEF-4                                           1.342k ± 0%
ReadSTEFZ-4                                          1.375k ± 0%
ReadSTEFZWriteSTEF-4                                 2.376k ± 0%
geomean                                              11.39k