code.pablomurad.com

alexandria

An endless, read-only library of Markdown from public GitHub repositories

docs/README.md raw 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# Alexandria Documentation

Complete technical documentation for the Alexandria GitHub Markdown Reader system.

## Documentation Index

### Core Documentation

- [Overview](overview.md) - System overview, purpose, and objectives
- [Architecture](architecture.md) - System architecture, stack, and design decisions
- [Features](features.md) - Detailed feature documentation

### Component Documentation

- [Pages](pages.md) - Page components (Home, Reader, About)
- [Components](components.md) - React component library
- [Services](services.md) - Service layer documentation

### Technical Guides

- [Configuration](configuration.md) - Environment variables and configuration
- [Deployment](deployment.md) - Build and deployment procedures
- [Development](development.md) - Developer setup and guidelines
- [API Usage](api-usage.md) - GitHub API integration details
- [Security](security.md) - Security measures and best practices

## Quick Navigation

**Getting Started:**
1. Read [Overview](overview.md) to understand the system
2. Review [Architecture](architecture.md) for system design
3. Follow [Development](development.md) for setup instructions

**For Developers:**
- [Development Guide](development.md)
- [Component Reference](components.md)
- [Service Documentation](services.md)

**For Deployment:**
- [Deployment Guide](deployment.md)
- [Configuration Reference](configuration.md)

**For Understanding the System:**
- [Architecture](architecture.md)
- [Features](features.md)
- [API Usage](api-usage.md)
- [Security](security.md)

## System Overview

Alexandria is a static web application that enables infinite navigation through GitHub markdown content. It provides a clean, focused reading experience for exploring documentation across millions of public repositories without requiring authentication.

Key characteristics:
- Client-side only application
- No backend server required
- No user tracking or analytics
- Offline-capable through local caching
- Rate limit aware with intelligent fallbacks

## Documentation Structure

This documentation is organized into logical sections covering all aspects of the system:

1. **Core Documentation** - High-level understanding of the system
2. **Component Documentation** - Detailed component and service references
3. **Technical Guides** - Practical guides for development and deployment

Each document is self-contained but cross-referenced for easy navigation.