Commit d5c2407
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
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
30 | 30 | | |
31 | 31 | | |
32 | 32 | | |
33 | | - | |
34 | | - | |
35 | | - | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
36 | 36 | | |
37 | 37 | | |
38 | 38 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
23 | 23 | | |
24 | 24 | | |
25 | 25 | | |
| 26 | + | |
26 | 27 | | |
27 | 28 | | |
28 | 29 | | |
29 | | - | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
30 | 34 | | |
31 | 35 | | |
32 | 36 | | |
| |||
157 | 161 | | |
158 | 162 | | |
159 | 163 | | |
| 164 | + | |
| 165 | + | |
160 | 166 | | |
161 | 167 | | |
162 | 168 | | |
| |||
0 commit comments