How dmarx/papers-feed-src works
Client-Side Components
• Browser Extension (Chrome/Firefox)
• Background.js for URL monitoring
• Popup interface for user interactions
• Options page for PAT configuration
GitHub Infrastructure
• Papers-Feed Repository (Data Lake)
• Issues system (acting as a database)
• GitHub Pages (hosting frontend)
• Papers-Feed-Src Repository (Source Code)
• Core processing logic
• Frontend templates
Processing Pipeline
• GitHub Actions Workflows
• Issue processing workflow
• Paper downloading workflow
• Frontend deployment workflow
Component Representation
• Use rectangles for main components
• Use hexagons for processing components
• Use clouds for external services (like arXiv)
Flow Directions
1. Browser Extension → GitHub Issues (paper visit events)
2. GitHub Actions → arXiv API (paper fetching)
3. Processing Pipeline → Generated Frontend
4. Frontend → GitHub Pages (deployment)
Specific Processes
• URL monitoring flow
• Issue creation process
• Paper processing pipeline
• Frontend generation and deployment
Specific Implementation Details to Highlight:
Data Flow
• Browser Extension
• → GitHub Issues
• → GitHub Actions
• → Processed Data
• → Generated Frontend
• → GitHub Pages
Key Services
• arxiv_client.py for paper fetching
• paper_manager.py for data processing
• markdown_service.py for content conversion
• frontend/generate_html.py for site generation
Configuration Points
• GitHub PAT configuration
• Repository settings
• GitHub Actions workflows
• Component types
• Status indicators
• The use of GitHub Issues as a database
• The integration between browser extension and GitHub
• The automated processing pipeline
• The static site generation process