Skip to content

Commit 75c68c5

Browse files
committed
docs: creates fixed 0.1.3 docs
1 parent 5f924ee commit 75c68c5

43 files changed

Lines changed: 886 additions & 91 deletions

Some content is hidden

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

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,8 @@ npm run docs:sync
157157
npm run start
158158
```
159159

160+
- **Versioned docs (like NoxTLS C):** snapshots live under `docs/versioned_docs/version-*` and are listed in `docs/versions.json`. When you ship a release, add an entry to `docs/changelog.json`, then from `docs/` run `npm run docs:snapshot -- X.Y.Z` (runs `docs:sync` then `docusaurus docs:version X.Y.Z`). Commit the updated `versioned_docs/`, `versioned_sidebars/`, and `versions.json`. Set `lastVersion` in `docs/docusaurus.config.js` to the newest published doc version.
161+
160162
- Record-layer integration notes: `docs/TLS13_RECORD_POLICY.md`
161163
- DTLS policy knobs: `docs/DTLS13_OPERATIONAL_POLICY.md`
162164

docs/changelog.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
{
22
"releases": [
3+
{
4+
"version": "0.1.3",
5+
"date": "2026-05-12",
6+
"changes": [
7+
"Documentation site versioning aligned with NoxTLS C docs: versioned snapshots under docs/versioned_docs/ and version dropdown (0.1.3, 0.1.0, Next).",
8+
"Crates.io publish flow, workspace crate versions, and expanded Docusaurus sidebar (including generated per-crate API pages)."
9+
],
10+
"fixed": [],
11+
"known_issues": []
12+
},
313
{
414
"version": "0.1.0",
515
"date": "2026-04-17",

docs/docs/api/crates/noxtls-core.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: noxtls-core
44

55
# `noxtls-core`
66

7-
Core profile flags, shared types, and utilities for the noxtls Rust stack.
7+
Internal implementation crate for noxtls: core profile flags, shared types, and utilities.
88

99
## Crate metadata
1010

docs/docs/api/crates/noxtls-crypto.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: noxtls-crypto
44

55
# `noxtls-crypto`
66

7-
Hash, symmetric cipher, public-key, and DRBG primitives for the noxtls Rust stack.
7+
Internal implementation crate for noxtls: hash, symmetric cipher, public-key, and DRBG primitives.
88

99
## Crate metadata
1010

docs/docs/api/crates/noxtls-io.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: noxtls-io
44

55
# `noxtls-io`
66

7-
Transport traits and blocking/async adapters for noxtls TLS record I/O.
7+
Internal implementation crate for noxtls: transport traits and blocking/async TLS record I/O adapters.
88

99
## Crate metadata
1010

docs/docs/api/crates/noxtls-pem.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: noxtls-pem
44

55
# `noxtls-pem`
66

7-
PEM encoding and decoding utilities for the noxtls Rust stack.
7+
Internal implementation crate for noxtls: PEM encoding and decoding utilities.
88

99
## Crate metadata
1010

docs/docs/api/crates/noxtls-platform.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: noxtls-platform
44

55
# `noxtls-platform`
66

7-
Time, RNG, and storage abstractions for portable noxtls integrations.
7+
Internal implementation crate for noxtls: time, RNG, and storage abstractions.
88

99
## Crate metadata
1010

docs/docs/api/crates/noxtls-psa.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: noxtls-psa
44

55
# `noxtls-psa`
66

7-
Public PSA Crypto adapter and provider abstractions for noxtls.
7+
Internal implementation crate for noxtls: PSA Crypto adapter and provider abstractions.
88

99
## Crate metadata
1010

docs/docs/api/crates/noxtls-test.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: noxtls-test
44

55
# `noxtls-test`
66

7-
Demo binaries and basic test helpers for the noxtls Rust workspace.
7+
Workspace-only demo binaries and test helpers; not published to crates.io.
88

99
## Crate metadata
1010

docs/docs/api/crates/noxtls-x509.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: noxtls-x509
44

55
# `noxtls-x509`
66

7-
X.509, ASN.1, and DER certificate utilities for the noxtls Rust stack.
7+
Internal implementation crate for noxtls: X.509, ASN.1, and DER certificate utilities.
88

99
## Crate metadata
1010

0 commit comments

Comments
 (0)