OSA/mkdocs.yml at main · korhenon/OSA · 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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
site_name: Open-Source-Advisor
theme:
  name: material
  features:
  - navigation.top
  - navigation.footer
  - navigation.tabs
  - toc.integrate

extra:
  social:
    - icon: fontawesome/brands/telegram
      link: https://t.me/osa_helpdesk
    - icon: fontawesome/brands/github
      link: https://github.com/aimclub/OSA

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: false
            show_root_heading: true
            show_object_full_path: false

nav:
  - Home: index.md
  - Scheduler: scheduler/index.md
  - Workflow Generator: workflow-generator/index.md
  - API Reference:
      - Core:
          - Git Agent: api/core/git/git_agent.md
          - Git Metadata: api/core/git/metadata.md
          - Model Handler: api/core/llm/llm.md
          - Models:
              - Agent Status: api/core/models/agent_status.md
              - Event: api/core/models/event.md
              - Task: api/core/models/task.md
      - Config:
          - OSA Config: api/config/osa_config.md
          - Settings: api/config/settings.md
      - Operations:
          - Available Operations: api/operations/OPERATIONS.md
          - Catalog: api/operations/operations_catalog.md
          - Registry: api/operations/registry.md
          - Analysis:
              - Repository Report Generator: api/operations/analysis/repository_report/report_generator.md
              - Repository Report Maker: api/operations/analysis/repository_report/report_maker.md
              - Repository Report Validation: api/operations/analysis/repository_report/response_validation.md
              - Repository Code Analyzer: api/operations/analysis/repository_validation/code_analyzer.md
              - Repository Doc Validator: api/operations/analysis/repository_validation/doc_validator.md
              - Repository Paper Validator: api/operations/analysis/repository_validation/paper_validator.md
              - Repository Validation Report Generator: api/operations/analysis/repository_validation/report_generator.md
          - Codebase:
              - Directory Translation: api/operations/codebase/directory_translation/dirs_and_files_translator.md
              - Docstring Generation:
                  - Docgen: api/operations/codebase/docstring_generation/docgen.md
                  - Docstring Generation: api/operations/codebase/docstring_generation/docstring_generation.md
                  - OSA Tree Sitter: api/operations/codebase/docstring_generation/osa_treesitter.md
                  - Topology: api/operations/codebase/docstring_generation/topology.md
              - Notebook Conversion: api/operations/codebase/notebook_conversion/notebook_converter.md
              - Organization: api/operations/codebase/organization/repo_organizer.md
              - Requirements Generation: api/operations/codebase/requirements_generation/requirements_generation.md
              - Workflow Generation:
                - Workflow Executor: api/operations/codebase/workflow_generation/workflow_executor.md
                - Workflow Generator: api/operations/codebase/workflow_generation/workflow_generator.md
          - Docs:
              - About Generator: api/operations/docs/about_generation/about_generator.md
              - Community Docs:
                  - Community: api/operations/docs/community_docs_generation/community.md
                  - Contributing: api/operations/docs/community_docs_generation/contributing.md
                  - Docs Run: api/operations/docs/community_docs_generation/docs_run.md
                  - License Generation: api/operations/docs/community_docs_generation/license_generation.md
              - README Generation:
                  - README Agent: api/operations/docs/readme_generation/readme_agent.md
                  - Sections:
                      - Header: api/operations/docs/readme_generation/sections/header.md
                      - Installation: api/operations/docs/readme_generation/sections/installation.md
                  - Pipeline:
                      - Graph: api/operations/docs/readme_generation/pipeline/graph.md
                      - State: api/operations/docs/readme_generation/pipeline/state.md
                      - Runtime Context: api/operations/docs/readme_generation/pipeline/runtime_context.md
                      - Models: api/operations/docs/readme_generation/pipeline/models.md
                      - LLM Schemas: api/operations/docs/readme_generation/pipeline/llm_schemas.md
                      - Section Catalog: api/operations/docs/readme_generation/pipeline/section_catalog.md
                      - Section Catalog Entries: api/operations/docs/readme_generation/pipeline/section_catalog_entries.md
                      - Nodes:
                          - Assembler: api/operations/docs/readme_generation/pipeline/nodes/assembler.md
                          - Context Collector: api/operations/docs/readme_generation/pipeline/nodes/context_collector.md
                          - Deterministic Builder: api/operations/docs/readme_generation/pipeline/nodes/deterministic_builder.md
                          - Intent Analyzer: api/operations/docs/readme_generation/pipeline/nodes/intent_analyzer.md
                          - README Patch: api/operations/docs/readme_generation/pipeline/nodes/readme_patch.md
                          - Section Generator: api/operations/docs/readme_generation/pipeline/nodes/section_generator.md
                          - Section Planner: api/operations/docs/readme_generation/pipeline/nodes/section_planner.md
                          - Self Eval: api/operations/docs/readme_generation/pipeline/nodes/self_eval.md
                          - Writer: api/operations/docs/readme_generation/pipeline/nodes/writer.md
      - Agents:
          - Base: api/osa_agent/base.md
          - Context: api/osa_agent/context.md
          - Graph: api/osa_agent/graph.md
          - State: api/osa_agent/state.md
          - Executor Agent: api/osa_agent/agents/executor/agent.md
          - Finalizer Agent: api/osa_agent/agents/finalizer/agent.md
          - Finalizer Models: api/osa_agent/agents/finalizer/models.md
          - Intent Router Agent: api/osa_agent/agents/intent_router/agent.md
          - Intent Router Models: api/osa_agent/agents/intent_router/models.md
          - Planner Agent: api/osa_agent/agents/planner/agent.md
          - Planner Models: api/osa_agent/agents/planner/models.md
          - Repo Analysis Agent: api/osa_agent/agents/repo_analysis/agent.md
          - Reviewer Agent: api/osa_agent/agents/reviewer/agent.md
          - Reviewer Models: api/osa_agent/agents/reviewer/models.md
      - Scheduler:
          - Scheduler: api/scheduler/scheduler.md
          - Plan: api/scheduler/plan.md
          - Workflow Manager: api/scheduler/workflow_manager.md
          - Response Validation: api/scheduler/response_validation.md
      - Tools:
          - Repository Analysis:
              - Dependencies: api/tools/repository_analysis/dependencies.md
              - Documentation: api/tools/repository_analysis/documentation.md
              - Models: api/tools/repository_analysis/models.md
              - Repo Analyzer: api/tools/repository_analysis/repo_analyzer.md
              - Sourcerank: api/tools/repository_analysis/sourcerank.md
              - Testing: api/tools/repository_analysis/testing.md
  - FAQ:
      - Overview: faq/index.md
      - General Questions: faq/general-questions.md
      - Installation & Setup: faq/installation-setup.md
      - Configuration & API Keys: faq/configuration-api-keys.md
      - Usage & Features: faq/usage-features.md
      - Troubleshooting: faq/troubleshooting.md
      - Contributing & Community: faq/contributing-community.md
      - Technical Details: faq/technical-details.md

repo_url: https://github.com/aimclub/OSA

markdown_extensions:
  - admonition
  - codehilite
  - footnotes
  - meta
  - pymdownx.tasklist:
      custom_checkbox: true
  - toc:
      permalink: True
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - attr_list