Files
Aniworld/docs
Lukas ecfa8d3c10 feat: Add NFO UI features (Task 6)
- Extended AnimeSummary model with NFO fields (has_nfo, nfo_created_at, nfo_updated_at, tmdb_id, tvdb_id)
- Updated list_anime endpoint to fetch and return NFO data from database
- Added NFO status badges to series cards (green=exists, gray=missing)
- Created nfo-manager.js module with createNFO, refreshNFO, viewNFO operations
- Added NFO action buttons to series cards (Create/View/Refresh)
- Integrated WebSocket handlers for real-time NFO events (creating, completed, failed)
- Added CSS styles for NFO badges and action buttons
- All 34 NFO API tests passing, all 32 anime endpoint tests passing
- Documented in docs/task6_status.md (90% complete, NFO status page deferred)
2026-01-16 19:18:50 +01:00
..
2025-12-15 14:07:04 +01:00
2025-12-15 14:07:04 +01:00
2025-12-15 14:07:04 +01:00
2025-12-15 14:07:04 +01:00
2025-12-15 14:07:04 +01:00

Aniworld Documentation

Overview

This directory contains all documentation for the Aniworld anime download manager project.

Documentation Structure

Document Purpose Target Audience
ARCHITECTURE.md System architecture and design decisions Architects, Senior Developers
API.md REST API reference and WebSocket documentation Frontend Developers, API Consumers
DEVELOPMENT.md Developer setup and contribution guide All Developers
DEPLOYMENT.md Deployment and operations guide DevOps, System Administrators
DATABASE.md Database schema and data models Backend Developers
TESTING.md Testing strategy and guidelines QA Engineers, Developers
SECURITY.md Security considerations and guidelines Security Engineers, All Developers
CONFIGURATION.md Configuration options reference Operators, Developers
CHANGELOG.md Version history and changes All Stakeholders
TROUBLESHOOTING.md Common issues and solutions Support, Operators
features.md Feature list and capabilities Product Owners, Users
instructions.md AI agent development instructions AI Agents, Developers

Documentation Standards

  • All documentation uses Markdown format
  • Keep documentation up-to-date with code changes
  • Include code examples where applicable
  • Use clear, concise language
  • Include diagrams for complex concepts (use Mermaid syntax)

Contributing to Documentation

When adding or updating documentation:

  1. Follow the established format in each document
  2. Update the README.md if adding new documents
  3. Ensure cross-references are valid
  4. Review for spelling and grammar