friTap Documentation¶

This directory contains the comprehensive documentation for friTap, built with MkDocs and Material for MkDocs.

Documentation Structure¶

docs/
├── index.md                 # Homepage
├── getting-started/         # Installation and basic usage
│   ├── installation.md
│   ├── quick-start.md
│   └── concepts.md
├── examples/               # Comprehensive usage examples
│   ├── index.md
│   ├── desktop.md
│   ├── android.md
│   └── malware.md
├── platforms/              # Platform-specific guides
│   ├── index.md
│   ├── android.md
│   ├── ios.md
│   ├── linux.md
│   ├── windows.md
│   └── macos.md
├── advanced/               # Advanced features
│   └── patterns.md
├── libraries/              # SSL/TLS library specific guides
│   ├── index.md
│   └── others.md
├── api/                    # API reference
│   ├── python.md
│   └── cli.md
├── troubleshooting/        # Issue resolution
│   └── common-issues.md
└── development/            # Developer resources
    └── contributing.md

Building Documentation Locally¶

Prerequisites¶

Install the required dependencies:

pip install -r docs/requirements.txt

Or install individually:

pip install mkdocs-material mkdocstrings[python] mkdocs-mermaid2-plugin

Local Development¶

Start the development server:

mkdocs serve

The documentation will be available at http://localhost:8000 with live-reload enabled.

Build Static Site¶

Generate the static documentation:

mkdocs build

The built site will be in the site/ directory.

Deployment¶

Documentation is automatically built and deployed via GitHub Actions when changes are pushed to the main branch. The workflow is defined in .github/workflows/docs.yml.

Manual Deployment¶

To deploy manually to GitHub Pages:

mkdocs gh-deploy

Writing Documentation¶

Style Guide¶

Use clear, concise language
Include practical examples with commands
Add code syntax highlighting
Use admonitions for important information
Cross-reference related sections

Code Examples¶

Use language-specific syntax highlighting:

```bash
fritap -k keys.log firefox
```

```python
from friTap import SSL_Logger
logger = SSL_Logger()
```

Admonitions¶

Use admonitions for important information:

!!! warning "Security Notice"
    Always analyze malware in isolated environments.

!!! tip "Pro Tip"
    Use verbose mode for debugging: `fritap -v target`

!!! note "Platform Support"
    This feature is only available on Android.

Cross-References¶

Link to other documentation sections:

See the [Installation Guide](getting-started/installation.md) for setup instructions.

For mobile analysis, check [Android Examples](examples/android.md).

Configuration¶

The documentation is configured in mkdocs.yml with:

Theme: Material Design with dark/light mode toggle
Plugins: Search, API documentation generation, git info
Extensions: Code highlighting, tabs, admonitions, emoji
Navigation: Hierarchical structure with sections

Contributing¶

To contribute to the documentation:

Edit markdown files in the docs/ directory
Test locally with mkdocs serve
Submit pull request with changes
Review deployment after merge

Adding New Pages¶

Create markdown file in appropriate directory
Add to navigation in mkdocs.yml
Update index pages with links
Cross-reference from related pages

Images and Assets¶

Place images in docs/assets/ and reference as:

![Description](assets/image.png)

Maintenance¶

Regular Tasks¶

Update examples with new friTap features
Review links for accuracy
Update version numbers in installation guides
Add new troubleshooting cases from user feedback

Quality Checks¶

The CI pipeline includes:

Build verification: Ensures documentation builds successfully
Link checking: Validates internal and external links
Spelling: Checks for common typos (future enhancement)

Contact¶

For documentation-related questions:

GitHub Issues: Report documentation bugs or suggest improvements
Pull Requests: Contribute directly to documentation
Email: daniel.baier@fkie.fraunhofer.de