Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,55 @@
# wtfdocs

A documentation and browser management tool built with Tauri.

## Features

- Browser discovery and management
- Cross-platform support (Windows, macOS, Linux)
- Built with Rust and Tauri

## Documentation

For detailed information, see the [docs](./docs) folder.

### Core Documentation
- **[Browser Discovery Overview](./docs/browser-discovery-overview.md)** - Complete guide to how browser discovery works
- Frontend to Rust backend communication flow
- Tauri command implementation
- Platform-specific filesystem access
- Interactive mermaid sequence diagrams
- Windows troubleshooting and edge cases

- **[Documentation Index](./docs/README.md)** - Full documentation navigation and quick links

## Getting Started

```bash
# Install dependencies
npm install

# Run development server
npm run tauri dev

# Build for production
npm run tauri build
```

## Development

This project uses:
- **Tauri** - Desktop app framework
- **Rust** - Backend logic
- **React/Vue** - Frontend UI

## Contributing

Contributions are welcome! Please see the [Contributing Guidelines](./CONTRIBUTING.md).

## License

[Your License Here]

# WTF Docs

This site is built using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).
Expand Down
33 changes: 33 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Documentation

Welcome to the WTFDocs documentation!

## Core Guides

- [Browser Discovery Overview](./browser-discovery-overview.md) - Complete guide to browser detection, from frontend to filesystem
- Frontend integration with Tauri IPC
- Rust backend command implementation
- Platform-specific filesystem access
- Windows troubleshooting and edge cases
- Sequence diagrams and architecture

## Additional Resources

- [Main README](../README.md)
- [Contributing Guidelines](../CONTRIBUTING.md)

## Quick Links

### Architecture
- [Discovery Flow Diagrams](./browser-discovery-overview.md#sequence-diagrams)
- [Platform Implementation](./browser-discovery-overview.md#platform-specific-implementation)

### Development
- [Frontend Integration](./browser-discovery-overview.md#frontend-integration)
- [Tauri Commands](./browser-discovery-overview.md#tauri-commands)
- [Filesystem Access](./browser-discovery-overview.md#filesystem-access)

### Troubleshooting
- [Windows Edge Cases](./browser-discovery-overview.md#windows-specific-edge-cases)
- [General Troubleshooting](./browser-discovery-overview.md#general-troubleshooting)
- [Performance Optimization](./browser-discovery-overview.md#performance-considerations)
Loading