BestBlogs Documentation

repository·main·Indexed 26 days ago

https://github.com/ginobefun/bestblogs

An AI-driven personal reading assistant and API for curated content discovery. Includes documentation for the @bestblogs/cli (v2.2.0), the OpenAPI v2 contract for programmatic access to intake, discovery, reading, and capture modules, and agent-native skills for integration with AI coding agents like Claude Code and Cursor.

Tokens
109.4K
Snippets
117
Records
500
Agent score
83%

What's inside BestBlogs

  1. Overview of the BestBlogs Article Analysis Workflow

    main

    The BestBlogs Article Analysis Workflow is a Dify-based process designed to ingest a website article ID and produce a comprehensive analysis. The workflow uses HTTP and code nodes to fetch article metadata (title, source, link, language) and full text via the website's API.

    Key features include:

    • Adaptive Processing: Articles longer than 6,000 characters are automatically segmented for processing, while shorter articles are analyzed in full.
    • Rich Content Extraction: Generates a one-sentence summary, abstract, keywords, main viewpoints, and golden quotes.
    • Categorization: Uses LLMs to assign domains and tags (e.g., themes, technologies, products, companies, trends) to improve search and recommendation.
    • Multi-dimensional Scoring: Evaluates content depth, writing quality, utility, and relevance.
    • Self-Correction Loop: Includes a 'Check & Reflect' node where an LLM acts as a technical reviewer to ensure comprehensiveness, accuracy, and consistency, followed by an 'Optimization' node to refine the final output.

    Developers can integrate this workflow into website applications by calling the Dify Workflow API with an article ID.

  2. Overview of BestBlogs System Components

    main

    BestBlogs is composed of several specialized components that define its system boundaries. Developers interacting with the platform should identify which component matches their use case:

    • bestblogs-app: Public website and user Web interface.
    • bestblogs-admin: Administrative backend.
    • bestblogs-api: User-facing API, authentication, Pro features, reading, and personalization capabilities.
    • bestblogs-admin-api: Administrative API, content processing, and background task hosting.
    • bestblogs-common: Shared domain models, configurations, Adapters, and infrastructure.
    • bestblogs-worker: Independent background task modules.
    • bestblogs-mobile: iOS / Android client modules (currently on hold).
    • dujian-app: 'Dujian' (读见), the localized version for domestic deployment and Chinese presentation.
    • bestblogs-cli: CLI and Agent-friendly entry point.
    • bestblogs-skills: Agent Skills wrapper layer.
  3. Overview of BestBlogs 2.0 Reading Workflow

    main

    BestBlogs 2.0 transitions from a content aggregation platform to a comprehensive "reading workflow" system. Instead of just collecting high-quality content (articles, podcasts, videos, tweets), the product focuses on helping users discover, judge, and consume information more efficiently.

    Key components of the workflow include:

    • Public Layer: A curated pool of analyzed and filtered content (Daily Briefs, featured content, searchable pages) to reduce initial information noise.
    • Personalized Layer: Content tailored to individual interests and reading behaviors via "My Daily Brief" and "Recommended for You."
    • Subscription Management: Tools to manage content inputs and define personal interest boundaries.
    • AI Companion (AI 伴读): Integrated AI assistance to help explain complex topics or expand on content without disrupting the reading rhythm.
  4. Overview of BestBlogs Podcast and Video Sources

    main

    BestBlogs maintains a curated collection of 176 sources, consisting of 57 Xiaoyuzhou (小宇宙) podcasts and 119 active YouTube channels. These sources are categorized into 8 domains including Artificial Intelligence, Software Programming, Business & Tech, Investment & Finance, Media, Product Design, Efficiency & Growth, and Life & Culture. Each podcast episode and video undergoes content analysis and quality scoring to help users identify high-value content.

    Source Distribution by Category

    CategoryPodcastsVideosTotal
    Artificial Intelligence34043
    Software Programming01616
    Business & Tech253560
    Investment & Finance527
    Media112
    Product Design01212
    Efficiency & Growth7714
    Life & Culture16622
    Total57119176
  5. Understand the BestBlogs Core Capabilities

    main

    BestBlogs provides a unified quality judgment system for high-quality information input across multiple platforms, media types, and languages.

    Key Capabilities:

    • Multi-source Access: Aggregates content from RSS, Newsletters, Twitter, YouTube, and Podcasts.
    • Multi-media Support: Handles articles, podcasts, videos, and tweets.
    • Unified Content Processing: Performs extraction, cleaning, summarization, tagging, scoring, and translation.
    • Cross-language Support: Provides immersive translation, summaries, terminology explanations, and AI companion reading to allow users to access primary source content in multiple languages.
    • Public Quality Pool: A continuously calibrated content pool built through AI initial scoring and human calibration, accessible via Daily Newsletters, Weekly Digests, Topic Interpretations, Content Squares, and external interfaces like OpenAPI, RSS, or CLI.
  6. Understand the BestBlogs Development Workflow

    main

    The project follows a structured development workflow designed to minimize manual overhead through automated skills and hooks. There are two primary entry points for new work:

    1. /feat (Large Requirements): Used for cross-module changes, product decisions, or architectural shifts. It follows a heavy planning phase (/office-hours/autoplan) before moving to implementation.
    2. /fix (Small Requirements/Bugs): Used for minor changes or bug fixes. It skips the heavy planning phase and moves directly from issue creation to development.

    Both paths converge at the /dev coding loop, /deepreview phase, and eventually the /release process. For daily development, refer to CLAUDE.md in the monorepo root for specific execution rules like branch naming and commit conventions.

  7. Understand the BestBlogs Monorepo Structure

    main

    BestBlogs uses a monorepo structure to maintain consistency across domain models, repositories, configurations, and shared capabilities. The repository is organized into the following primary units:

    • bestblogs-app: User Web interface (public pages, daily reports, personal space).
    • bestblogs-admin: Management interface (content auditing, configuration, Pro management).
    • bestblogs-service:
      • bestblogs-api: User-facing API (authentication, content queries, AI assistance).
      • bestblogs-admin-api: Management API and background job host.
      • bestblogs-worker: Task domain library (not independently deployed).
      • bestblogs-common: Shared domain models, repository interfaces, and adapters.
    • dujian-app: Localized Web version for domestic (China) deployment.
    • deploy: Deployment and environment templates.
  8. Understand the BestBlogs Brand Positioning

    main

    BestBlogs is an AI-driven personal reading assistant designed to help users establish a stable, credible, and personalized high-quality information input. It focuses on three core capabilities:

    1. Determining what is worth reading: Identifying signals and filtering out noise from massive content streams.
    2. Assisting in comprehension: Using summaries, translations, explanations, Q&A, chapter jumping, and AI companion reading to lower the cost of understanding long or cross-language content.
    3. Learning user interests: Continuously adapting to user preferences through follows, interest tags, reading, bookmarks, highlights, and feedback.

    Core Philosophy: BestBlogs does not read or judge for the user. AI handles filtering, ranking, explanation, and association, but the user always decides what to read, what to believe, and how to form judgments. The goal is "Better content for you," not "More content."

  9. Strategic Product Roadmap for BestBlogs

    main

    Based on recent insights, the BestBlogs product strategy is evolving from a simple 'recommendation tool' to an 'AI Content Harness'. The goal is to provide a high-quality consumption experience that protects users' 'free attention' by using minimal 'bounded attention' to capture critical signals.

    Key strategic pillars include:

    • User Context & Data Flywheel: Leveraging user behavior (six-dimensional interest tags, reading completion rates, and bookmarks) to create a feedback loop for content scoring models.
    • L4 Experience Standard: Aiming for a level of service where the BestBlogs morning report effectively replaces hours of manual RSS/social media scanning.
    • Skills-based AI Integration: Converting operational expertise (scoring standards, editorial norms, tagging systems) into structured Skills that can be injected into Agent workflows.
    • Content Expansion: Moving beyond LLM/Coding topics to cover 'Physical World AI' (Robotics, Embodied AI, Autonomous Driving).
  10. Understand the concept of Skills for AI Agents

    main

    A Skill is a way to teach an AI Agent how to perform specific tasks. For many workflows, the barrier to creating a Skill is low. A Skill is essentially a Markdown document that clearly defines:

    1. Trigger conditions: When the skill should be activated.
    2. Interface calls: Which APIs or interfaces to call.
    3. Data processing: How to handle incoming data.
    4. Output presentation: How the final result should be formatted and presented.

    By describing a process clearly in Markdown, an AI Agent can follow the instructions to execute the workflow.

  11. Explore BestBlogs Capabilities and Integrations

    main

    BestBlogs provides several core capabilities across content understanding and external access:

    • Content Understanding: Includes AI summaries, immersive translation, AI reading companion, and podcast/video transcription.
    • Personalization: Driven by a six-dimensional interest tag system, follow sources, reading behavior, and feedback signals.
    • External Access: Provides OpenAPI and CLI capabilities covering content discovery, reading, and personal workflow paths.
    • Mobile: Note that mobile-specific features and the dujian-app (a localized version for domestic deployment) are currently in a pending state for future verification.
  12. Understand the BestBlogs Agent Native architecture

    main

    BestBlogs is designed as an 'Agent Native' platform, meaning its capabilities are structured to be easily called, composed, and orchestrated by both humans and AI agents (like Claude Code, Cursor, or OpenClaw). Instead of just providing a web interface, BestBlogs provides three layers of access to integrate reading workflows into larger automation pipelines:

    1. OpenAPI: The foundational layer providing stable, structured contracts for authentication, interest profiling, content discovery, deep reading, collection, and note-taking.
    2. CLI (bestblogs-cli): A lightweight command-line interface designed for shell scripts and automation. It organizes capabilities into a logical reading workflow: intake → discover → read → capture.
    3. Skills (bestblogs-skills): The highest layer, providing high-level primitives specifically for AI agent orchestration. It currently includes 5 skills and 25 stable primitives covering profiling, discovery, deep reading, accumulation, and explanation.