Skip to content

Commit c66bd8d

Browse files
iAviProiAviPro
committed
Updates docs
1 parent 00cddf6 commit c66bd8d

File tree

10 files changed

+1196
-0
lines changed

10 files changed

+1196
-0
lines changed

‎docs/.gitignore‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Jekyll
2+
_site/
3+
.sass-cache/
4+
.jekyll-cache/
5+
.jekyll-metadata
6+
7+
# Ruby
8+
Gemfile.lock
9+
10+
# macOS
11+
.DS_Store
12+
13+
# IDEs
14+
.vscode/
15+
.idea/
16+
17+
# Logs
18+
*.log

‎docs/404.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
layout: default
3+
title: Page Not Found
4+
permalink: /404.html
5+
---
6+
7+
# 404 - Page Not Found
8+
9+
The page you're looking for doesn't exist.
10+
11+
## Quick Links
12+
13+
- [Home]({{ '/' | relative_url }})
14+
- [Architecture]({{ '/ARCHITECTURE' | relative_url }})
15+
- [Features]({{ '/FEATURES' | relative_url }})
16+
- [Commands]({{ '/COMMANDS' | relative_url }})
17+
- [Testing]({{ '/TESTING' | relative_url }})
18+
19+
## Need Help?
20+
21+
- Check out our [GitHub Repository](https://github.com/iAviPro/testteller-agent)
22+
- Browse the [README](https://github.com/iAviPro/testteller-agent/blob/main/README.md)
23+
- Report an issue on [GitHub Issues](https://github.com/iAviPro/testteller-agent/issues)

‎docs/Gemfile‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
source "https://rubygems.org"
2+
3+
# GitHub Pages gem
4+
gem "github-pages", group: :jekyll_plugins
5+
6+
# Plugins
7+
group :jekyll_plugins do
8+
gem "jekyll-seo-tag"
9+
gem "jekyll-sitemap"
10+
gem "jekyll-feed"
11+
gem "jemoji"
12+
end
13+
14+
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
15+
# and associated library.
16+
platforms :mingw, :x64_mingw, :mswin, :jruby do
17+
gem "tzinfo", ">= 1", "< 3"
18+
gem "tzinfo-data"
19+
end
20+
21+
# Performance-booster for watching directories on Windows
22+
gem "wdm", "~> 0.1", :platforms => [:mingw, :x64_mingw, :mswin]
23+
24+
# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
25+
# do not have a Java counterpart.
26+
gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]
27+
28+
# For serving locally
29+
gem "webrick", "~> 1.8"

‎docs/README.md‎

Lines changed: 173 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,173 @@
1+
# TestTeller Documentation Site
2+
3+
This folder contains the Jekyll-powered documentation site for TestTeller.
4+
5+
## Local Development
6+
7+
### Prerequisites
8+
9+
- Ruby (version 2.5.0 or higher)
10+
- Bundler (`gem install bundler`)
11+
12+
### Setup
13+
14+
1. Navigate to the docs directory:
15+
```bash
16+
cd docs/
17+
```
18+
19+
2. Install dependencies:
20+
```bash
21+
bundle install
22+
```
23+
24+
3. Serve the site locally:
25+
```bash
26+
bundle exec jekyll serve
27+
```
28+
29+
4. Open your browser to `http://localhost:4000/testteller-agent/`
30+
31+
### Live Reload
32+
33+
For development with live reload:
34+
```bash
35+
bundle exec jekyll serve --livereload
36+
```
37+
38+
## GitHub Pages Deployment
39+
40+
This site is automatically deployed to GitHub Pages when changes are pushed to the main branch. The site will be available at:
41+
42+
```
43+
https://iAviPro.github.io/testteller-agent/
44+
```
45+
46+
## Theme Customization
47+
48+
The site uses a custom minimal theme. To customize:
49+
50+
1. **Colors and Typography**: Edit variables in `assets/css/style.css`
51+
2. **Layout**: Modify `_layouts/default.html`
52+
3. **Navigation**: Update the `navigation` section in `_config.yml`
53+
54+
### Available Theme Options
55+
56+
You can also use GitHub Pages supported themes by updating `_config.yml`:
57+
58+
```yaml
59+
# Minimal theme (clean and simple)
60+
remote_theme: pages-themes/minimal@v0.2.0
61+
62+
# Cayman theme (modern with gradient header)
63+
remote_theme: pages-themes/cayman@v0.2.0
64+
65+
# Slate theme (dark and professional)
66+
remote_theme: pages-themes/slate@v0.2.0
67+
68+
# Architect theme (clean with blueprints aesthetic)
69+
remote_theme: pages-themes/architect@v0.2.0
70+
71+
# Hacker theme (terminal-style dark theme)
72+
remote_theme: pages-themes/hacker@v0.2.0
73+
```
74+
75+
## File Structure
76+
77+
```
78+
docs/
79+
├── _config.yml # Jekyll configuration
80+
├── _layouts/ # Page layouts
81+
│ └── default.html # Main layout template
82+
├── assets/ # Static assets
83+
│ └── css/
84+
│ ├── style.css # Main stylesheet
85+
│ └── syntax.css # Code syntax highlighting
86+
├── index.md # Homepage
87+
├── ARCHITECTURE.md # Architecture documentation
88+
├── COMMANDS.md # CLI commands reference
89+
├── FEATURES.md # Features documentation
90+
├── TESTING.md # Testing guide
91+
├── Gemfile # Ruby dependencies
92+
└── README.md # This file
93+
```
94+
95+
## Writing Documentation
96+
97+
### Front Matter
98+
99+
All markdown files should include front matter:
100+
101+
```yaml
102+
---
103+
layout: default
104+
title: Page Title
105+
description: Page description for SEO
106+
---
107+
```
108+
109+
### Syntax Highlighting
110+
111+
Use fenced code blocks with language specification:
112+
113+
````markdown
114+
```python
115+
def hello_world():
116+
print("Hello, World!")
117+
```
118+
````
119+
120+
### Linking
121+
122+
- Internal links: `[Architecture](ARCHITECTURE.md)`
123+
- External links: `[GitHub](https://github.com/iAviPro/testteller-agent)`
124+
- Anchor links: `[Section](#section-id)`
125+
126+
## Troubleshooting
127+
128+
### Bundle Install Fails
129+
130+
If you encounter issues with `bundle install`:
131+
132+
```bash
133+
# Update bundler
134+
gem update bundler
135+
136+
# Try installing with specific platform
137+
bundle lock --add-platform x86_64-linux
138+
bundle install
139+
```
140+
141+
### Jekyll Serve Fails
142+
143+
If Jekyll won't start:
144+
145+
```bash
146+
# Clean Jekyll cache
147+
bundle exec jekyll clean
148+
149+
# Rebuild site
150+
bundle exec jekyll build
151+
152+
# Then serve
153+
bundle exec jekyll serve
154+
```
155+
156+
### Page Not Found
157+
158+
Make sure your baseurl is set correctly in `_config.yml`:
159+
160+
```yaml
161+
baseurl: "/testteller-agent" # For GitHub Pages
162+
# or
163+
baseurl: "" # For custom domain
164+
```
165+
166+
## Contributing
167+
168+
When adding new documentation:
169+
170+
1. Create a new `.md` file in the docs folder
171+
2. Add appropriate front matter
172+
3. Update navigation in `_config.yml` if needed
173+
4. Test locally before pushing

‎docs/_config.yml‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
# Jekyll Configuration for TestTeller Documentation
2+
3+
# Site settings
4+
title: TestTeller Documentation
5+
description: AI-Powered Test Generation and Automation Agent
6+
author: TestTeller Team
7+
email:
8+
url: "https://iaviPro.github.io"
9+
baseurl: "/testteller-agent"
10+
11+
# Theme settings
12+
theme: minima
13+
# For GitHub Pages, you can also use:
14+
# remote_theme: pages-themes/minimal@v0.2.0
15+
# remote_theme: pages-themes/cayman@v0.2.0
16+
# remote_theme: pages-themes/slate@v0.2.0
17+
18+
# Build settings
19+
markdown: kramdown
20+
highlighter: rouge
21+
22+
# Kramdown settings
23+
kramdown:
24+
input: GFM
25+
syntax_highlighter: rouge
26+
syntax_highlighter_opts:
27+
css_class: 'highlight'
28+
span:
29+
line_numbers: false
30+
block:
31+
line_numbers: false
32+
33+
# Plugins
34+
plugins:
35+
- jekyll-seo-tag
36+
- jekyll-sitemap
37+
- jekyll-feed
38+
- jemoji
39+
40+
# Collections
41+
collections:
42+
docs:
43+
output: true
44+
permalink: /:path
45+
46+
# Defaults
47+
defaults:
48+
- scope:
49+
path: ""
50+
type: "pages"
51+
values:
52+
layout: "default"
53+
- scope:
54+
path: ""
55+
type: "docs"
56+
values:
57+
layout: "doc"
58+
59+
# Navigation
60+
navigation:
61+
- title: Home
62+
url: /
63+
- title: Architecture
64+
url: /ARCHITECTURE
65+
- title: Features
66+
url: /FEATURES
67+
- title: Commands
68+
url: /COMMANDS
69+
- title: Testing
70+
url: /TESTING
71+
72+
# External links
73+
github_repo: https://github.com/iAviPro/testteller-agent
74+
pypi_url: https://pypi.org/project/testteller/
75+
docker_hub: https://hub.docker.com/r/iavipro/testteller
76+
77+
# Exclude from build
78+
exclude:
79+
- Gemfile
80+
- Gemfile.lock
81+
- README.md
82+
- LICENSE
83+
- CNAME
84+
- .gitignore
85+
86+
# SEO
87+
twitter:
88+
username:
89+
card: summary
90+
logo: /assets/images/logo.png
91+
92+
# Google Analytics (optional)
93+
google_analytics:
94+
95+
# Disqus Comments (optional)
96+
disqus:
97+
shortname:

0 commit comments

Comments
 (0)