Wikis

​

Introduction

​

Prerequisites

​

System Integration with ELITEA

​

Request Wikis Application Access

1. Navigate to Apps: Open the sidebar and select Apps.
2. Open the App Catalog tab: Select the App Catalog tab to browse available applications.
3. Locate the Wikis card: Find the Wikis card in the catalog.
4. Click Request Access: Click the Request Access button on the Wikis card.
5. Provide a reason: In the request modal, enter a description of why you need access to the Wikis application.
6. Submit the request: Click Submit to send the request to your administrator.
7. Await approval: Once approved, the card updates and the Configure button becomes available.
8. Proceed with configuration: Follow the steps in Create Wikis Application to set up the application.

​

Create Wikis Application

1. Navigate to Apps: Open the sidebar and select Apps.
2. Open the App Catalog tab: Select the App Catalog tab to browse available applications.
3. Locate the Wikis card: Find the Wikis card in the catalog.
4. Start configuration: Click the Configure button on the Wikis card. This opens the application configuration form.
5. Configure Application Settings:

   Parameter	Required	Description	Example
   Toolkit Name	Yes	Descriptive name for the application	”Project Documentation Generator”
   Description	No	Optional description of the application’s purpose	”Generates wiki documentation for main project repo”
   LLM Model	Yes	LLM model for text generation and wiki content creation	”gpt-4”, “claude-sonnet-3-5”
   Embedding Model	No	Embedding model for vector search and retrieval (default: text-embedding-3-small)	“text-embedding-3-small”
   Code Toolkit	Yes	Code toolkit (GitHub, GitLab, Bitbucket, or ADO Repos) for accessing repository data	Select from configured toolkits
   Max Tokens	Yes	Maximum tokens for LLM responses (default: 64000)	64000, 128000
   Tools	No	Select which tools to enable (default: all tools)	generate_wiki, ask, deep_research

6. Save Application: Click Save to create the application.

​

Available Tools

​

Applications Tab

1. Navigate to the Apps menu in the sidebar and select the Applications tab.
2. Click on your Wikis application card.
3. The Wikis interface opens. Here you can manage wiki generation, access generated documentation, and monitor repository analysis.

If no applications have been configured yet, the Applications tab shows an empty state with the message “No applications yet”. Click + Create to open the App Catalog, or click Start Guided Tour to take an interactive walkthrough.

​

Working with the Wikis Application

• Left Sidebar: Navigation panel for browsing generated wiki pages organized by sections
• Main Content Area: Wiki content with formatted markdown, code blocks, and diagrams
• Chat Panel: (Right side) For asking questions about your codebase using natural language

​

Wiki Generation Workflow

Check Slot Availability Before Starting

Wiki generation runs on a limited number of parallel worker slots. Before clicking Generate Wiki, check the slot availability indicator chip next to the button — if all slots are occupied, your generation will be queued until one becomes free.

• Green chip — slots available, generation starts immediately
• Yellow chip — only 1 slot remaining, proceed with caution
• Red chip — all slots full, wait for a running generation to complete before starting a new one

1. In the left sidebar, locate and click the “Generate Wiki” button.
2. In the “Generate Wiki Documentation?” dialog:
   • Under Structure planner, select a mode:
     • Graph clustering (recommended) — builds the outline deterministically from code-graph clusters; scales predictably from small repos to large monorepos
     • Agentic — the planner agent drafts the outline iteratively; may over-segment small or doc-light repositories
   • If Graph clustering is selected, optionally enable “Smart skip tests” to exclude test files from the cluster planner and keep the outline focused
   • Click “Update” to start generation, or “Cancel” to abort

• Progress Bar: Appears below the Generate Wiki button
• Status Messages: Real-time updates show current operations (e.g., “Analyzing repository structure…”, “Building knowledge graph…”)
• Elapsed Time: Counter displays how long generation has been running

If you need to stop an in-progress generation, click the “Stop Generation” button in the sidebar. Note that partial results may not be saved.

​

Access Generated Documentation

1. The left sidebar populates with navigation sections
2. Click on any section to expand and view wiki pages
3. Select a page to view its content in the main area
4. Generated content includes:
   • Formatted markdown documentation
   • Code examples with syntax highlighting
   • Mermaid diagrams for visualizations
   • Cross-references between related topics

​

Edit Wiki Pages

1. Navigate to the wiki page you want to modify
2. Click the Edit button (pencil icon) in the top-right corner of the page
3. The page opens in an editor with markdown formatting
4. Make your changes to the content
5. Click Save to apply changes or Cancel to discard

• Markdown Editing: Full markdown support for formatting text, adding links, creating lists, and more
• Code Blocks: Modify or add code examples with syntax highlighting
• Diagrams: Edit Mermaid diagram definitions to update visualizations
• Content Organization: Restructure sections, add new information, or clarify existing content

​

Update Generated Wiki

1. Make changes to your repository code, comments, or documentation files
2. Commit and push your changes to the repository
3. Return to the Wikis application interface
4. Click the “Generate Wiki” button in the left sidebar
5. Confirm the regeneration in the dialog
6. Wikis will re-analyze the repository and update all sections

​

Wiki Artifacts Storage

wiki-artifacts/
├── _registry/wikis.json              # Global registry of all wikis
└── {wiki_id}/                        # Folder per wiki (e.g. owner--repo--branch)
    ├── wiki_manifest_{version}.json  # Versioned manifest (one per generation)
    ├── wiki_pages/                   # Generated markdown pages
    │   ├── {section}/
    │   │   └── {page}.md
    │   └── README.md
    ├── analysis/
    │   └── wiki_structure.json
    ├── {hash}.faiss                  # Vector index
    ├── {hash}.docstore.bin
    ├── {hash}.bm25.sqlite
    └── combined.code_graph.gz

​

Managing Settings

1. In the left sidebar, click the “Settings” button (below Generate Wiki button)
2. The Settings panel opens from the right side

• Delete Wiki: Removes all generated wiki artifacts from the bucket
  • Use this to clean up old documentation before regenerating
  • This action cannot be undone

1. Modify any editable configuration field
2. Click “Save Settings” button at the bottom
3. Settings are immediately applied to the toolkit

​

Use the Chat Interface

1. Locate the vertical Chat tab on the right edge of the interface
2. Click it to slide open the chat drawer

1. Select your preferred tool using the toggle: Ask or Research
2. Type your question in natural language
3. Press Enter or click the Send button
4. The response streams in real time with thinking steps visible during processing
5. Use the copy, regenerate, or clear controls on each response as needed

​

Using Wikis in Your Workflows

​

Step 1: Create a Query Toolkit

• Wikis Query (Single Wiki)
• Wiki Query (Multi-Wiki)

Use this toolkit when your agent always queries one specific repository. It connects directly to a named Wikis application and exposes ask and deep_research for that wiki only.

1

Navigate to Toolkits

Open the sidebar and select Toolkits.

2

Create a New Toolkit

Click + Create Toolkit. The toolkit type selector opens.

3

Select Wikis Query

Search for or scroll to Wikis Query in the type list and click it. The configuration form opens.

4

Configure the Toolkit

Fill in the toolkit settings:

Parameter	Required	Description
Name	Yes	A descriptive name for this toolkit (e.g., “Backend Repo Q&A”)
Description	No	Optional description of what repository this connects to
Wikis Toolkit	Yes	Select the existing Wikis application to connect to — the dropdown shows all configured Wikis applications in the project
LLM Model	Yes	LLM model used to answer questions
Embedding Model	Yes	Embedding model used for vector search (must match the model used during wiki generation)
Tools	Yes	Enable the tools the agent should use: ask, deep_research

5

Save the Toolkit

Click Save. The Wikis Query toolkit is now available to add to agents, chats, and pipelines.

Use this toolkit when your agent needs to query multiple repositories or should automatically determine which wiki to use based on the question. It connects to the wiki registry and resolves queries across all available wikis.

1

Navigate to Toolkits

Open the sidebar and select Toolkits.

2

Create a New Toolkit

Click + Create Toolkit. The toolkit type selector opens.

3

Select Wiki Query

Search for or scroll to Wiki Query in the type list and click it. The configuration form opens.

4

Configure the Toolkit

Fill in the toolkit settings:

Parameter	Required	Description
Name	Yes	A descriptive name for this toolkit (e.g., “Multi-Repo Wiki Search”)
Description	No	Optional description
LLM Model	Yes	LLM model used for repository resolution and answering questions
Embedding Model	Yes	Embedding model for vector search
Tools	Yes	Enable the tools the agent should use: list_wikis, resolve_and_ask, resolve_and_deep_research, delete_wiki

5

Save the Toolkit

Click Save. The Wiki Query toolkit is now available to add to agents, chats, and pipelines.

​

Step 2: Add the Toolkit to an Agent, Chat, or Pipeline

​

Best Practices

​

Troubleshooting

​

FAQ