CogniCryptSQPlugin/mkdocs.yml at main · secure-software-engineering/CogniCryptSQPlugin · 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
110
111
112
113
114
site_name: SecAI Plugin Documentation
site_description: Hereby is the Documentation of SecAI plugin!
site_author: Secure-Systems-Engineering Dept., Paderborn University
site_url: https://secure-software-engineering.github.io/CogniCryptSQPlugin/
use_directory_urls: false


# Repository info
repo_name: secure-software-engineering/CogniCryptSQPlugin
repo_url: https://github.com/secure-software-engineering/CogniCryptSQPlugin
edit_uri: edit/testing/docs/ # Change to main branch when needed!


# Theme configuration
theme:
  name: material
  palette:
    - scheme: default
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.indexes
    - navigation.top
    - search.highlight
    - search.share
    - content.code.copy

# Navigation structure
nav:
  - Home: index.md
  - Getting Started:
    - Setup: getting-started/overview.md
    - Prerequisites: getting-started/prerequisites.md
    - First Analysis: getting-started/first-analysis.md
  - User Guide:
    - Overview: user-guide/overview.md
    - Confidence Scores and Quick Fixes: user-guide/vulnerabilities-list.md
    - Error Tree: user-guide/error-tree.md
    - AIFix: user-guide/aifix.md
    - Code Generation: user-guide/code-gen.md
    - GitHub Pull Request Integration: user-guide/github-pr-integration.md
  - Extension Guide:
    - Adding New Analysis Tools: extension-guide/add-tool.md
    - Custom SonarQube Properties: extension-guide/custom-properties.md
    - Useful Classes:
      - Jar Generation: extension-guide/jar-generation.md
      - Code Snippet: extension-guide/code-snippet.md
  - Implementation Notes:
    - Overview: implementation-notes/overview.md
    - Custom SonarQube Web Page:
      - Issue Management: implementation-notes/issue-management.md
      - Error Tree: implementation-notes/error-tree.md
      - Diff-View: implementation-notes/diff-view.md
      - Github PR: implementation-notes/github-pr-integration.md
    - AI Features:
      - AiFix: implementation-notes/AiFix.md
      - Code Generation: implementation-notes/code-gen.md
    - CogniCrypt Integration:
      - Overview: cognicrypt/overview.md
      - Extracting Additional Information: cognicrypt/cc-message-deconstruction.md
      - Editing the Error Message: cognicrypt/cc-message-edit.md
      - Accurate Error Location: cognicrypt/cc-location.md
      - Severity: cognicrypt/severity.md
      - False Positive Detection: cognicrypt/false-positive-detection.md
      - CogniCrypt Rules in SonarQube: cognicrypt/cc-rules.md
    - Testing During Development:
      - Overview: testing/overview.md
      - Running Tests: testing/running-tests.md
      - Writing Tests: testing/writing-tests.md
      - Test Data: testing/test-data.md
  - API Reference: api-reference.md
  - Contributing: contributing.md

# Extensions
markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - md_in_html
  - toc:
      permalink: true

# Plugins
plugins:
  - search
  - git-revision-date-localized

# Extra
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/secure-software-engineering/CogniCryptSQPlugin
  version:
    provider: mike