llmshieldr/_pkgdown.yml at main · ineelhere/llmshieldr · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
url: https://www.indraneelchakraborty.com/llmshieldr/

template:
  bootstrap: 5
  light-switch: true
  bootswatch: zephyr

development:
  mode: auto

home:
  title: llmshieldr
  description: Safety guardrails for LLM workflows in R, now on CRAN.
  links:
  - text: View CRAN release
    href: https://CRAN.R-project.org/package=llmshieldr

navbar:
  structure:
    left: [intro, reference, articles]
    right: [search, cran, github, lightswitch]
  components:
    intro:
      text: Get Started
      href: articles/getting-started.html
    cran:
      text: CRAN
      href: https://CRAN.R-project.org/package=llmshieldr
    github:
      icon: fa-github
      href: https://github.com/ineelhere/llmshieldr
      aria-label: GitHub

reference:
  - title: Policies and Rules
    contents:
      - build_policy
      - policy
      - available_policies
      - policy_controls
      - add_rule
      - remove_rule
      - list_rules
      - starts_with("rule_")

  - title: Scanners
    contents:
      - scan_prompt
      - preflight_check
      - scan_context
      - scan_output
      - scan_conversation
      - scan_stream
      - scan_tool_call
      - scan_tool_output
      - scanner_options
      - redaction_strategy

  - title: Orchestration
    contents:
      - secure_chat
      - shield_ollama
      - ollama_reviewer
      - remote_reviewer
      - trust_boundary
      - rate_guard

  - title: Audit and Explanation
    contents:
      - write_audit_log
      - explain_findings
      - example_prompts
      - evaluate_security_cases
      - reviewer_prompt

  - title: Constructors
    contents:
      - shieldr_rule
      - shieldr_policy
      - shieldr_report
      - shieldr_audit
      - shieldr_result
      - print.shieldr_policy
      - print.shieldr_report

articles:
  - title: Articles
    navbar: ~
    contents:
      - getting-started
      - ollama-usage
      - policy-design
      - custom-rules
      - rag-pipeline
      - owasp-coverage
      - evaluation
      - threat-model
      - operations
      - architecture
      - ecosystem-context

search:
  enabled: true

footer:
  structure:
    left: [developed_by]
  components:
    developed_by: Developed by <a href="https://www.linkedin.com/in/indraneelchakraborty/" target="_blank">Indraneel Chakraborty</a>