docs

ResourceBuddy Documentation

Welcome to the ResourceBuddy documentation. This folder contains all technical documentation, guides, and references for the project.

Documentation Structure

📋 Setup

Installation and configuration guides

• Setup Guide - Initial setup and installation

🎯 Features

Documentation for all features and functionality

• Search Features
  • Search Features Index - Overview of all search capabilities
  • Advanced Search - Enterprise search interface
  • Guided Search System - Step-by-step search wizard
  • Metadata Click Search - Quick search by clicking metadata
• UI Components
  • Modal Improvements - Enhanced modal system
  • Resource Modal Management - Resource preview modals
  • Modal Dynamic Resize - Responsive modal sizing
  • Metadata Panel Redesign - Enhanced metadata display
  • Metadata Panel Resize Fix - Panel resizing improvements
  • Test Modal Fix - Modal testing fixes
• Other Features
  • Admin Panel Improvements - Admin interface enhancements
  • Authentication Flow - User authentication system
  • Sorting Feature - Resource sorting capabilities

🔧 Technical

Technical documentation and architecture details

• Cache System Documentation - Caching architecture
• Cache Performance Explained - Performance optimization
• Upload Workflow Changes - File upload improvements
• Upload Fix Summary - Upload bug fixes
• CORS Setup - Cross-origin configuration

🔌 API

API documentation and integration guides

• ResourceSpace Hooks and APIs - RS API reference
• ResourceSpace Codebase Analysis - RS integration details

💻 Development

Development workflows and guidelines

• Test Workflow - Testing procedures

Quick Links

• Getting Started: See Setup Guide
• Search Implementation: Start with Search Features Index
• API Integration: Check ResourceSpace Hooks and APIs
• Performance: Read Cache System Documentation

Project Structure

rs_art_station/
├── backend/          # Node.js backend server
├── web-ui/          # React frontend application
├── services/        # Microservices (cache API, etc.)
├── resourcespace/   # ResourceSpace core files
├── docker/          # Docker configuration
└── docs/           # This documentation

Contributing

When adding new documentation:

1. Place it in the appropriate subfolder
2. Update this index file
3. Follow the existing naming convention (FEATURE_NAME.md)
4. Include clear headings and examples