📚 Linuxy Documentation Index
Complete documentation for the Linuxy AppImage Manager project.
Repository: https://github.com/swadhinbiswas/linuxy
🚀 Quick Start
For Users
- Installation Guide - How to install Linuxy
- Usage Guide - How to use Linuxy
- Application Info - Window controls, icons,
signatures
For Contributors
- Contributing Guide - How to contribute
- Code of Conduct - Community guidelines
- Maintenance Guide - Repository maintenance
📖 Documentation Files
Core Documentation
| File | Purpose | Audience |
|---|---|---|
| README.md | Project overview and quick start | Everyone |
| CONTRIBUTING.md | Contribution guidelines | Contributors |
| CODE_OF_CONDUCT.md | Community code of conduct | Everyone |
| LICENSE | MIT License | Everyone |
| CHANGELOG.md | Version history | Everyone |
User Documentation
| File | Purpose | Audience |
|---|---|---|
| docs/INSTALL.md | Installation instructions | Users |
| docs/USAGE.md | Usage guide and tips | Users |
| APPLICATION_INFO.md | App info (icons, signatures, etc.) | Users |
| website.html | Landing page | Visitors |
Developer Documentation
| File | Purpose | Audience |
|---|---|---|
| docs/MAINTENANCE.md | Repository maintenance | Maintainers |
| docs/CODE_SIGNING.md | Code signing guide | Maintainers |
| SECURITY.md | Security policy | Security researchers |
| .github/BRANCH_PROTECTION.md | Branch protection rules | Maintainers |
🔧 Configuration Files
GitHub Configuration
| File | Purpose |
|---|---|
| .github/workflows/ci.yml | CI/CD pipeline |
| .github/workflows/release.yml | Release automation |
| .github/workflows/codeql.yml | Security analysis |
| .github/workflows/stale.yml | Close stale issues |
| .github/workflows/welcome.yml | Welcome new contributors |
| .github/workflows/labeler.yml | Auto-label PRs |
| .github/dependabot.yml | Dependency updates |
| .github/CODEOWNERS | Code ownership |
| .github/labeler.yml | Label configuration |
| .github/release-drafter.yml | Release notes draft |
Code Quality
| File | Purpose |
|---|---|
| .eslintrc.yml | ESLint configuration |
| .prettierrc.yml | Prettier formatting |
| .editorconfig | Editor settings |
| src-tauri/rustfmt.toml | Rust formatting |
| src-tauri/clippy.toml | Rust linting |
| .coderabbit.yml | CodeRabbit AI review |
IDE/Editor
| File | Purpose |
|---|---|
| .vscode/settings.json | VS Code workspace settings |
| .vscode/extensions.json | Recommended extensions |
📦 Package Information
Project Details
Name: Linuxy
Version: 0.1.0
License: MIT (Open Source)
Maintainer: Swadhin Biswas <[email protected]>
Developer: @swadhinbiswas
Identifier: com.linuxy.dev
Repository: https://github.com/swadhinbiswas/linuxy
Build Commands
# Development
npm run dev # Start Vite dev server
npm run tauri:dev # Start Tauri dev app
# Code Quality
npm run lint # Run ESLint
npm run format # Format with Prettier
npm run typecheck # TypeScript check
npm run check # Run all checks
# Building
npm run build # Build frontend
npm run tauri:build # Build full application
# Rust
cd src-tauri && cargo clippy # Rust linting
cd src-tauri && cargo fmt # Rust formatting
cd src-tauri && cargo audit # Security audit
🌐 Online Resources
GitHub
- Repository: https://github.com/swadhinbiswas/linuxy
- Issues: https://github.com/swadhinbiswas/linuxy/issues
- Pull Requests: https://github.com/swadhinbiswas/linuxy/pulls
- Releases: https://github.com/swadhinbiswas/linuxy/releases
- Discussions: https://github.com/swadhinbiswas/linuxy/discussions
- Actions (CI/CD): https://github.com/swadhinbiswas/linuxy/actions
External
- Tauri Framework: https://tauri.app
- AppImage: https://appimage.org
- Firejail: https://firejail.wordpress.com
📋 Documentation Status
Completed ✅
- README.md - Project overview
- CONTRIBUTING.md - Contribution guide
- CODE_OF_CONDUCT.md - Community guidelines
- SECURITY.md - Security policy
- docs/INSTALL.md - Installation guide
- docs/USAGE.md - Usage guide
- docs/MAINTENANCE.md - Maintenance guide
- docs/CODE_SIGNING.md - Code signing guide
- APPLICATION_INFO.md - Application information
- CHANGELOG.md - Version history
- website.html - Landing page
GitHub Configuration ✅
- CI/CD workflows
- CodeRabbit AI review
- Dependabot auto-updates
- Issue and PR templates
- Branch protection rules
- Code owners
- Release drafter
- Stale issue handler
- Welcome bot
Code Quality ✅
- ESLint configuration
- Prettier formatting
- Rust Clippy linting
- Rust formatting
- EditorConfig
- VS Code settings
🤝 Contributing to Documentation
If you find errors or want to improve documentation:
- Create an issue:
https://github.com/swadhinbiswas/linuxy/issues/new?template=docs_issue.yml - Submit a PR: https://github.com/swadhinbiswas/linuxy/pulls
- Start a discussion: https://github.com/swadhinbiswas/linuxy/discussions
Documentation Guidelines
- Use clear, concise language
- Include examples where helpful
- Keep formatting consistent
- Update related docs when making changes
- Test command examples before committing
📞 Support
- Report a bug:
https://github.com/swadhinbiswas/linuxy/issues/new?template=bug_report.yml - Request a feature:
https://github.com/swadhinbiswas/linuxy/issues/new?template=feature_request.yml - Ask a question: https://github.com/swadhinbiswas/linuxy/discussions
Last Updated: March 2024
License: MIT (Open Source)
Repository: https://github.com/swadhinbiswas/linuxy