Files
MajoorWaldi-ComfyUI-Majoor-…/docs/DOCUMENTATION_INDEX.md
T
Ewald ba272531ef feat(viewer): enhance player bar manager with active video asset tracking
- Added `_activeVideoAssetId` to track the currently active video asset in `playerBarManager.js`.
- Updated sync logic to ensure controls are remounted only when the asset changes.
- Improved handling of video synchronization and FPS settings.

feat(sideBySide): sanitize prompts for display

- Introduced `sanitizePromptForDisplay` to clean up prompts before displaying.
- Updated `_extractGridGenInfo` to use the new sanitization function for prompts.

feat(sidebar): enhance workflow section with size options and stats

- Added size options for the minimap in `SidebarWorkflowSection.vue`.
- Implemented workflow statistics display, including nodes, links, and groups.
- Persisted size and label settings for the minimap.

fix(generation): prevent filepath prompts from being displayed

- Updated prompt handling in `generationSectionState.js` to sanitize prompts.
- Added tests to ensure filepath-like prompts do not affect UI behavior.

feat(gridLoader): implement adaptive paging for grid loader

- Introduced `getAdaptivePageLimit` to dynamically adjust page size based on empty append batches.
- Updated `useGridLoader` to utilize adaptive paging logic.

feat(vectorIndexer): add regex for path-like prompts

- Implemented `_looks_like_path_prompt` to identify and handle path-like prompts in `vector_indexer.py`.

test: add unit tests for prompt sanitization and grid loader

- Created tests for prompt sanitization logic in `generation_prompt_sanitization.vitest.mjs`.
- Added tests for adaptive paging behavior in `grid_loader_adaptive_paging.vitest.mjs`.
- Implemented tests for sidebar workflow section functionality in `sidebar_workflow_section.vitest.mjs`.
- Added tests for player bar FPS synchronization in `viewer_player_bar_fps_sync.vitest.mjs`.

docs: update user guide and add privacy/offline documentation

- Added a privacy and offline usage guide in `PRIVACY_OFFLINE.md`.
- Updated user guide to reference new privacy documentation.
2026-04-07 10:35:43 +02:00

103 lines
4.2 KiB
Markdown

# Majoor Assets Manager - Documentation Index
Welcome to the documentation hub for **Majoor Assets Manager** for ComfyUI.
**Current Version**: 2.4.4
**Last Updated**: April 5, 2026
## Quick Start
### New users
1. **[Installation Guide](INSTALLATION.md)** - Install and set up the extension
2. **[User Guide (HTML)](../user_guide.html)** - Visual walkthrough with screenshots
3. **[Hotkeys & Shortcuts](HOTKEYS_SHORTCUTS.md)** - Essential keyboard shortcuts
4. **[Basic Search](SEARCH_FILTERING.md)** - Find assets quickly
### Returning users
- **[AI Features Guide](AI_FEATURES.md)** - AI-assisted search and enrichment features
- **[Viewer Feature Tutorial](VIEWER_FEATURE_TUTORIAL.md)** - Floating viewer and analysis tools
- **[Changelog](../CHANGELOG.md)** - Recent releases and fixes
- **[Architecture Map](ARCHITECTURE_MAP.md)** - Backend boundaries and refactor guide
### Privacy And Offline Use
- **[PRIVACY_OFFLINE.md](PRIVACY_OFFLINE.md)** - Dedicated privacy, offline, and token explanation page
- **[AI_FEATURES.md](AI_FEATURES.md)** - Local AI processing, model downloads, offline behavior, and token clarification
- **[SECURITY_ENV_VARS.md](SECURITY_ENV_VARS.md)** - Remote access security, API token behavior, and safe defaults
- **[SETTINGS_CONFIGURATION.md](SETTINGS_CONFIGURATION.md)** - UI security settings and token storage behavior
## Documentation Categories
### Getting Started
| Document | Description |
|----------|-------------|
| **[INSTALLATION.md](INSTALLATION.md)** | Detailed installation instructions |
| **[user_guide.html](../user_guide.html)** | Full visual user guide |
| **[HOTKEYS_SHORTCUTS.md](HOTKEYS_SHORTCUTS.md)** | Keyboard shortcuts |
| **[SHORTCUTS.md](SHORTCUTS.md)** | Extra gestures and shortcuts |
### Core Features
| Document | Description |
|----------|-------------|
| **[SEARCH_FILTERING.md](SEARCH_FILTERING.md)** | Full-text search, filters, and sorting |
| **[VIEWER_FEATURE_TUTORIAL.md](VIEWER_FEATURE_TUTORIAL.md)** | Viewer, MFV, and analysis tools |
| **[RATINGS_TAGS_COLLECTIONS.md](RATINGS_TAGS_COLLECTIONS.md)** | Ratings, tags, and collections |
| **[DRAG_DROP.md](DRAG_DROP.md)** | Drag and drop behavior |
| **[AI_FEATURES.md](AI_FEATURES.md)** | Semantic search, auto-tags, and enrichment |
### Configuration And Security
| Document | Description |
|----------|-------------|
| **[PRIVACY_OFFLINE.md](PRIVACY_OFFLINE.md)** | Dedicated privacy, offline behavior, and token clarification guide |
| **[SETTINGS_CONFIGURATION.md](SETTINGS_CONFIGURATION.md)** | UI and runtime settings |
| **[SECURITY_ENV_VARS.md](SECURITY_ENV_VARS.md)** | Environment variables and security model |
| **[THREAT_MODEL.md](THREAT_MODEL.md)** | Threats, mitigations, and residual risk |
| **[ARCHITECTURE_MAP.md](ARCHITECTURE_MAP.md)** | Package responsibilities and internal boundaries |
### Maintenance And Development
| Document | Description |
|----------|-------------|
| **[DB_MAINTENANCE.md](DB_MAINTENANCE.md)** | Database maintenance and recovery |
| **[TESTING.md](TESTING.md)** | Tests, reports, and quality gate |
| **[API_REFERENCE.md](API_REFERENCE.md)** | Backend endpoint reference |
| **[adr/](adr/)** | Architecture Decision Records |
## Quality And Verification
Use the canonical gate from the repo root:
```bash
python scripts/run_quality_gate.py
```
Useful variants:
```bash
python scripts/run_quality_gate.py --python-only --skip-tests
tox -e quality
npm run test:js
```
The quality gate enforces:
- UTF-8 text files without BOM
- `ruff` linting on changed Python files during the migration window
- `mypy`
- `bandit`
- `pip-audit`
- xenon/radon complexity checks
- backend tests
- frontend tests
- `npm audit`
## Security Note
The backend keeps a compatibility-first local security model:
- loopback writes remain allowed by default
- remote writes are denied unless explicitly authorized
- `MAJOOR_REQUIRE_AUTH=1` switches to strict token-auth for local writes too
Current releases also support a Settings-first remote setup flow:
- `Recommended Remote LAN Setup` is the preferred one-click LAN path
- the current browser session exposes its state through the runtime `Write auth:` indicator inside Assets Manager
That nuance is intentional and is the documented target behavior for current releases.