Skip to content

docs: include PII redaction Rust API reference #280

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
willkill07 wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −4
Open

docs: include PII redaction Rust API reference #280

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions scripts/docs/fern_cleanup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@
"[Node.js Library Reference](/reference/api/nodejs-library-reference), and\n"
"[Rust Library Reference](/reference/api/rust-library-reference) for generated\n"
"symbol-level documentation. The Rust reference includes `nemo-relay`,\n"
"`nemo-relay-adaptive`, and `nemo-relay-ffi`. For Go and WebAssembly surfaces, use\n"
"the source directories, tests, and task-focused guides when you need exact\n"
"behavior."
"`nemo-relay-adaptive`, `nemo-relay-pii-redaction`, and `nemo-relay-ffi`.\n"
"For Go and WebAssembly surfaces, use the source directories, tests, and\n"
"task-focused guides when you need exact behavior."
)
ASSISTANT_SYMBOL_REFERENCE_TEXT = (
"For symbol-level work, assistants should use the source directories, tests, and\n"
Expand Down
8 changes: 7 additions & 1 deletion scripts/docs/generate_rust_library_reference.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,14 @@
CRATES = (
("nemo-relay", "nemo_relay", "Core Rust runtime APIs for NeMo Relay."),
("nemo-relay-adaptive", "nemo_relay_adaptive", "Adaptive runtime primitives and plugin components."),
("nemo-relay-pii-redaction", "nemo_relay_pii_redaction", "PII redaction plugin components for NeMo Relay."),
("nemo-relay-ffi", "nemo_relay_ffi", "C-compatible FFI surface for NeMo Relay."),
)
BASE_URL = "/reference/api/rust-library-reference"
GENERATED_BY = "Generated from `cargo doc --no-deps -p nemo-relay -p nemo-relay-adaptive -p nemo-relay-ffi`."
GENERATED_BY = (
"Generated from `cargo doc --no-deps -p nemo-relay -p nemo-relay-adaptive "
"-p nemo-relay-pii-redaction -p nemo-relay-ffi`."
)
TRANSLATION_TABLE = str.maketrans(
{
"\xa0": " ",
Expand Down Expand Up @@ -157,6 +161,8 @@ def _run_cargo_doc(repo_root: Path) -> None:
"-p",
"nemo-relay-adaptive",
"-p",
"nemo-relay-pii-redaction",
"-p",
"nemo-relay-ffi",
],
cwd=repo_root,
Expand Down
Loading