-
Notifications
You must be signed in to change notification settings - Fork 568
docs: PM updates to Guardrails library docs #1543
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.
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
base: develop
Are you sure you want to change the base?
docs: PM updates to Guardrails library docs #1543
Conversation
Documentation preview |
Greptile OverviewGreptile SummaryThis PR updates the main documentation landing page (
Note: This change only affects
|
| Filename | Score | Overview |
|---|---|---|
| docs/index.md | 4/5 | Documentation terminology updated from "toolkit" to "library"; creates inconsistency with 44+ other doc files still using "toolkit". |
Sequence Diagram
sequenceDiagram
participant User
participant DocsIndex as docs/index.md
participant OtherDocs as Other Doc Files (44+)
User->>DocsIndex: Views landing page
DocsIndex-->>User: "NeMo Guardrails Library"
User->>OtherDocs: Navigates to other docs
OtherDocs-->>User: "NeMo Guardrails toolkit"
Note over User: Terminology inconsistency
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Additional Comments (1)
-
docs/index.md, line 6 (link)style: This PR updates "toolkit" to "library" in
docs/index.md, but 44+ other documentation files still reference "toolkit" (e.g.,docs/getting-started/installation-guide.md,docs/run-rails/index.md,docs/about/overview.md). Consider updating all documentation files for consistency, or note this as a follow-up task.
1 file reviewed, 1 comment
No description provided.