Skip to content

Commit d5c2407

Browse files
authored
docs: include PII redaction Rust API reference (NVIDIA#280)
#### Overview Add the `nemo-relay-pii-redaction` crate to the generated Fern Rust library reference so the Rust API docs include the first-party PII redaction plugin surface. - [x] I confirm this contribution is my own work, or I have the right to submit it under this project's license. - [x] I searched existing issues and open pull requests, and this does not duplicate existing work. #### Details - Added `nemo-relay-pii-redaction` to the Rust API reference generator crate list. - Included the crate in the `cargo doc --no-deps` invocation and generated-source label. - Updated Fern cleanup copy that enumerates the Rust crates covered by the generated reference. #### Where should the reviewer start? Start with `scripts/docs/generate_rust_library_reference.py`; it is the durable source for the ignored generated Fern Rust API pages. Validation: - `just docs-api-reference` - `npx fern check --warnings` (passed with the existing FDR redirects 403 warning) - `npx fern docs broken-links --strict` - `git diff --check` - Commit hook checks for the staged files #### Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to) - Relates to: none ## Summary by CodeRabbit * **Documentation** * Extended Rust API reference documentation to include the `nemo-relay-pii-redaction` library, providing developers with comprehensive reference materials alongside existing NeMo Relay crates. Signed-off-by: Will Killian <wkillian@nvidia.com>
1 parent 2841a32 commit d5c2407

2 files changed

Lines changed: 10 additions & 4 deletions

File tree

scripts/docs/fern_cleanup.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@
3030
"[Node.js Library Reference](/reference/api/nodejs-library-reference), and\n"
3131
"[Rust Library Reference](/reference/api/rust-library-reference) for generated\n"
3232
"symbol-level documentation. The Rust reference includes `nemo-relay`,\n"
33-
"`nemo-relay-adaptive`, and `nemo-relay-ffi`. For Go and WebAssembly surfaces, use\n"
34-
"the source directories, tests, and task-focused guides when you need exact\n"
35-
"behavior."
33+
"`nemo-relay-adaptive`, `nemo-relay-pii-redaction`, and `nemo-relay-ffi`.\n"
34+
"For Go and WebAssembly surfaces, use the source directories, tests, and\n"
35+
"task-focused guides when you need exact behavior."
3636
)
3737
ASSISTANT_SYMBOL_REFERENCE_TEXT = (
3838
"For symbol-level work, assistants should use the source directories, tests, and\n"

scripts/docs/generate_rust_library_reference.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,14 @@
2323
CRATES = (
2424
("nemo-relay", "nemo_relay", "Core Rust runtime APIs for NeMo Relay."),
2525
("nemo-relay-adaptive", "nemo_relay_adaptive", "Adaptive runtime primitives and plugin components."),
26+
("nemo-relay-pii-redaction", "nemo_relay_pii_redaction", "PII redaction plugin components for NeMo Relay."),
2627
("nemo-relay-ffi", "nemo_relay_ffi", "C-compatible FFI surface for NeMo Relay."),
2728
)
2829
BASE_URL = "/reference/api/rust-library-reference"
29-
GENERATED_BY = "Generated from `cargo doc --no-deps -p nemo-relay -p nemo-relay-adaptive -p nemo-relay-ffi`."
30+
GENERATED_BY = (
31+
"Generated from `cargo doc --no-deps -p nemo-relay -p nemo-relay-adaptive "
32+
"-p nemo-relay-pii-redaction -p nemo-relay-ffi`."
33+
)
3034
TRANSLATION_TABLE = str.maketrans(
3135
{
3236
"\xa0": " ",
@@ -157,6 +161,8 @@ def _run_cargo_doc(repo_root: Path) -> None:
157161
"-p",
158162
"nemo-relay-adaptive",
159163
"-p",
164+
"nemo-relay-pii-redaction",
165+
"-p",
160166
"nemo-relay-ffi",
161167
],
162168
cwd=repo_root,

0 commit comments

Comments
 (0)