Skip to content

Commit 5bfb5d0

Browse files
committed
Updates docs
1 parent d45e588 commit 5bfb5d0

File tree

3 files changed

+38
-85
lines changed

3 files changed

+38
-85
lines changed

docs/ARCHITECTURE.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -235,8 +235,3 @@ Configuration Layers:
235235
- **Metadata Control**: Fine-grained control over metadata storage and sharing
236236
- **Audit Trails**: Comprehensive logging for compliance and debugging
237237

238-
<!-- Mermaid.js CDN loader -->
239-
<script type="module">
240-
import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs';
241-
mermaid.initialize({ startOnLoad: true });
242-
</script>

docs/_layouts/default.html

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,25 @@
2020
<!-- Syntax Highlighting -->
2121
<link rel="stylesheet" href="{{ '/assets/css/syntax.css' | relative_url }}">
2222

23+
<!-- Mermaid Support -->
24+
<script src="https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.min.js"></script>
25+
<script>
26+
document.addEventListener('DOMContentLoaded', function() {
27+
mermaid.initialize({
28+
startOnLoad: true,
29+
theme: 'default',
30+
themeVariables: {
31+
primaryColor: '#2563eb',
32+
primaryTextColor: '#1e293b',
33+
primaryBorderColor: '#e2e8f0',
34+
lineColor: '#64748b',
35+
secondaryColor: '#f8fafc',
36+
tertiaryColor: '#f1f5f9'
37+
}
38+
});
39+
});
40+
</script>
41+
2342
{% seo %}
2443
{% feed_meta %}
2544
</head>

docs/index.md

Lines changed: 19 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,11 @@ layout: default
33
title: TestTeller Documentation
44
---
55

6+
<!-- This comment separates Jekyll front matter from content -->
7+
68
# TestTeller Documentation
79

8-
> **AI-Powered Test Generation and Automation Agent**
10+
**AI-Powered Test Generation and Automation Agent**
911

1012
[![PyPI](https://img.shields.io/pypi/v/testteller)](https://pypi.org/project/testteller/)
1113
[![Docker Hub](https://img.shields.io/docker/v/iavipro/testteller)](https://hub.docker.com/r/iavipro/testteller)
@@ -16,33 +18,12 @@ title: TestTeller Documentation
1618

1719
## Quick Navigation
1820

19-
<table>
20-
<tr>
21-
<td><b>📖 Documentation</b></td>
22-
<td><b>🚀 Resources</b></td>
23-
<td><b>🤝 Community</b></td>
24-
</tr>
25-
<tr>
26-
<td>
27-
<a href="ARCHITECTURE.md">Architecture</a><br>
28-
<a href="FEATURES.md">Features</a><br>
29-
<a href="COMMANDS.md">Commands</a><br>
30-
<a href="TESTING.md">Testing Guide</a>
31-
</td>
32-
<td>
33-
<a href="https://github.com/iAviPro/testteller-agent">GitHub Repository</a><br>
34-
<a href="https://github.com/iAviPro/testteller-agent/blob/main/README.md">README</a><br>
35-
<a href="https://pypi.org/project/testteller/">PyPI Package</a><br>
36-
<a href="https://hub.docker.com/r/iavipro/testteller">Docker Hub</a>
37-
</td>
38-
<td>
39-
<a href="https://github.com/iAviPro/testteller-agent/issues">Issues</a><br>
40-
<a href="https://github.com/iAviPro/testteller-agent/discussions">Discussions</a><br>
41-
<a href="https://github.com/iAviPro/testteller-agent/blob/main/CONTRIBUTING.md">Contributing</a><br>
42-
<a href="https://github.com/iAviPro/testteller-agent/blob/main/LICENSE">License</a>
43-
</td>
44-
</tr>
45-
</table>
21+
| 📖 Documentation | 🚀 Resources | 🤝 Community |
22+
|------------------|--------------|--------------|
23+
| [Architecture](ARCHITECTURE.md) | [GitHub Repository](https://github.com/iAviPro/testteller-agent) | [Issues](https://github.com/iAviPro/testteller-agent/issues) |
24+
| [Features](FEATURES.md) | [README](https://github.com/iAviPro/testteller-agent/blob/main/README.md) | |
25+
| [Commands](COMMANDS.md) | [PyPI Package](https://pypi.org/project/testteller/) | |
26+
| [Testing Guide](TESTING.md) | [Docker Hub](https://hub.docker.com/r/iavipro/testteller) | [License](https://github.com/iAviPro/testteller-agent/blob/main/LICENSE) |
4627

4728
---
4829

@@ -147,48 +128,14 @@ testteller automate test-cases.md --language python --framework pytest -c collec
147128

148129
---
149130

150-
## Architecture Overview
151-
152-
```mermaid
153-
graph TB
154-
A[Input Documents] --> B[Generator Agent]
155-
B --> C[Quality Assessment]
156-
C --> D{Quality Score > 0.7?}
157-
D -->|Yes| E[Vector Store]
158-
D -->|No| F[Discard]
159-
E --> G[Automator Agent]
160-
G --> H[Context Discovery]
161-
H --> I[Code Generation]
162-
I --> J[Validation]
163-
J --> K[Output]
164-
```
165-
166-
---
167-
168131
## Supported Frameworks
169132

170-
<table>
171-
<tr>
172-
<th>Language</th>
173-
<th>Frameworks</th>
174-
</tr>
175-
<tr>
176-
<td><b>Python</b></td>
177-
<td>pytest, unittest, behave, robot, locust</td>
178-
</tr>
179-
<tr>
180-
<td><b>JavaScript</b></td>
181-
<td>jest, mocha, cypress, playwright, puppeteer</td>
182-
</tr>
183-
<tr>
184-
<td><b>TypeScript</b></td>
185-
<td>jest, mocha, cypress, playwright</td>
186-
</tr>
187-
<tr>
188-
<td><b>Java</b></td>
189-
<td>junit, testng, selenide, restassured</td>
190-
</tr>
191-
</table>
133+
| Language | Frameworks |
134+
|----------|------------|
135+
| **Python** | pytest, unittest, behave, robot, locust |
136+
| **JavaScript** | jest, mocha, cypress, playwright, puppeteer |
137+
| **TypeScript** | jest, mocha, cypress, playwright |
138+
| **Java** | junit, testng, selenide, restassured |
192139

193140
---
194141

@@ -218,15 +165,7 @@ graph TB
218165

219166
---
220167

221-
<p align="center">
222-
<a href="https://github.com/iAviPro/testteller-agent">
223-
<img src="https://img.shields.io/github/stars/iAviPro/testteller-agent?style=social" alt="GitHub Stars">
224-
</a>
225-
<a href="https://pypi.org/project/testteller/">
226-
<img src="https://img.shields.io/pypi/dm/testteller" alt="PyPI Downloads">
227-
</a>
228-
</p>
229-
230-
<p align="center">
231-
<strong>TestTeller - Intelligent Test Agent for Modern Development</strong>
232-
</p>
168+
[![GitHub Stars](https://img.shields.io/github/stars/iAviPro/testteller-agent?style=social)](https://github.com/iAviPro/testteller-agent)
169+
[![PyPI Downloads](https://img.shields.io/pypi/dm/testteller)](https://pypi.org/project/testteller/)
170+
171+
**TestTeller - Intelligent Test Agent for Modern Development**

0 commit comments

Comments
 (0)