# Where to Find the Documentation for daily_stock_analysis: Complete Repository Guide

> Find daily_stock_analysis documentation easily. Access key information in README.md and the docs directory within the ZhuLinsen repository to quickly get started.

- Repository: [mumu/daily_stock_analysis](https://github.com/ZhuLinsen/daily_stock_analysis)
- Tags: documentation
- Published: 2026-04-30

---

**The documentation for daily_stock_analysis is located entirely within the ZhuLinsen/daily_stock_analysis repository, with primary reference materials stored in [`README.md`](https://github.com/ZhuLinsen/daily_stock_analysis/blob/main/README.md) and the `docs/` directory.**

The ZhuLinsen/daily_stock_analysis project maintains all technical documentation inside the repository itself. Users and developers can find comprehensive guides covering installation, configuration, and deployment alongside the source code. This approach ensures the documentation for daily_stock_analysis stays synchronized with every release.

## Primary Documentation Files

The repository organizes documentation hierarchically, starting with quick-start materials and progressing to specialized deployment guides.

### README.md: Quick Start and Overview

Located at the repository root, [`README.md`](https://github.com/ZhuLinsen/daily_stock_analysis/blob/main/README.md) provides the entry point for new users. It covers high-level architecture, core CLI commands, and basic usage examples to get the analysis pipeline running immediately.

### Comprehensive Guides (Chinese and English)

For detailed configuration and workflow explanations, consult [`docs/full-guide.md`](https://github.com/ZhuLinsen/daily_stock_analysis/blob/main/docs/full-guide.md) (Simplified Chinese) or [`docs/full-guide_EN.md`](https://github.com/ZhuLinsen/daily_stock_analysis/blob/main/docs/full-guide_EN.md) (English translation). These documents detail the data ingestion pipeline, technical indicator calculations, report rendering configuration, and production deployment strategies.

## Deployment and Platform-Specific Documentation

Beyond general usage, the repository includes targeted guides for specific deployment scenarios.

### Web UI and Cloud Deployment

The [`docs/deploy-webui-cloud.md`](https://github.com/ZhuLinsen/daily_stock_analysis/blob/main/docs/deploy-webui-cloud.md) file explains how to deploy the optional FastAPI-based web interface to cloud platforms like Zeabur. For Docker-based deployments specifically targeting Zeabur, reference [`docs/docker/zeabur-deployment.md`](https://github.com/ZhuLinsen/daily_stock_analysis/blob/main/docs/docker/zeabur-deployment.md), which includes container orchestration steps and environment variable configuration.

### Desktop Client Packaging

Users building the Electron desktop client should consult [`docs/desktop-package.md`](https://github.com/ZhuLinsen/daily_stock_analysis/blob/main/docs/desktop-package.md). This guide covers Node.js dependencies, build scripts, and binary distribution for the `apps/dsa-desktop` application.

## Integration and Extension References

### OpenClaw Skill Integration

Developers integrating with the OpenClaw skill-engine should review [`docs/openclaw-skill-integration.md`](https://github.com/ZhuLinsen/daily_stock_analysis/blob/main/docs/openclaw-skill-integration.md) for API contracts and webhook configuration.

### Image Extraction Prompts

The [`docs/image-extract-prompt.md`](https://github.com/ZhuLinsen/daily_stock_analysis/blob/main/docs/image-extract-prompt.md) file contains the prompt templates used by the image-stock extractor service, useful when customizing LLM-based data extraction workflows.

## Report Templates as Documentation

While not traditional markdown documentation, the Jinja2 templates under `templates/` illustrate output formatting options:

- `templates/report_wechat.j2` for WeChat-formatted reports
- `templates/report_markdown.j2` for plain markdown output
- `templates/report_brief.j2` for executive summaries

These files serve as practical references when customizing report layouts in [`src/report_renderer.py`](https://github.com/ZhuLinsen/daily_stock_analysis/blob/main/src/report_renderer.py).

## Key Source Files and Usage Examples

Understanding the documentation requires familiarity with these core modules.

### Entry Point and Orchestration

```python

# main.py: Central CLI orchestrator located at repository root

python main.py --stocks 600519,hk00700,AAPL --market-review

```

### Core Analytics Engine

The [`src/market_analyzer.py`](https://github.com/ZhuLinsen/daily_stock_analysis/blob/main/src/market_analyzer.py) module implements the technical analysis pipeline, fetching market data and generating trading signals.

### Web Interface

```bash

# Launch FastAPI server defined in src/webui_frontend.py

uvicorn server:app --reload --host 0.0.0.0 --port 8000

```

### Data Providers

[`data_provider/yfinance_fetcher.py`](https://github.com/ZhuLinsen/daily_stock_analysis/blob/main/data_provider/yfinance_fetcher.py) wraps the Yahoo Finance API with fallback logic for U.S. and Hong Kong indices.

### Desktop Build Process

```bash
cd apps/dsa-desktop
npm install
npm run build  # Generates Electron binary

```

### Testing Suite

The `tests/` directory contains pytest validation for data fetching, analysis algorithms, and notification services.

## Summary

- The documentation for daily_stock_analysis resides entirely in the repository under `docs/` and [`README.md`](https://github.com/ZhuLinsen/daily_stock_analysis/blob/main/README.md)
- Start with [`README.md`](https://github.com/ZhuLinsen/daily_stock_analysis/blob/main/README.md) for quick setup, then consult [`docs/full-guide_EN.md`](https://github.com/ZhuLinsen/daily_stock_analysis/blob/main/docs/full-guide_EN.md) for comprehensive English documentation
- Deployment guides exist for cloud platforms (Zeabur), Docker, and Electron desktop packaging
- Jinja2 templates in `templates/` provide reference implementations for report customization
- Core source files like [`main.py`](https://github.com/ZhuLinsen/daily_stock_analysis/blob/main/main.py) and [`src/market_analyzer.py`](https://github.com/ZhuLinsen/daily_stock_analysis/blob/main/src/market_analyzer.py) serve as authoritative implementation references

## Frequently Asked Questions

### Where is the daily_stock_analysis documentation hosted?

All documentation is stored directly in the ZhuLinsen/daily_stock_analysis GitHub repository. There is no external documentation site; the [`README.md`](https://github.com/ZhuLinsen/daily_stock_analysis/blob/main/README.md) and `docs/` directory contain the authoritative and version-controlled reference materials.

### Does daily_stock_analysis have English documentation?

Yes. While [`docs/full-guide.md`](https://github.com/ZhuLinsen/daily_stock_analysis/blob/main/docs/full-guide.md) contains the primary comprehensive guide in Simplified Chinese, [`docs/full-guide_EN.md`](https://github.com/ZhuLinsen/daily_stock_analysis/blob/main/docs/full-guide_EN.md) provides a complete English translation covering the same data sources, analysis pipeline, and deployment options.

### How do I deploy the daily_stock_analysis web interface?

Refer to [`docs/deploy-webui-cloud.md`](https://github.com/ZhuLinsen/daily_stock_analysis/blob/main/docs/deploy-webui-cloud.md) for platform-agnostic cloud deployment instructions, or [`docs/docker/zeabur-deployment.md`](https://github.com/ZhuLinsen/daily_stock_analysis/blob/main/docs/docker/zeabur-deployment.md) for Docker-specific Zeabur deployment. The web UI routes are implemented in [`src/webui_frontend.py`](https://github.com/ZhuLinsen/daily_stock_analysis/blob/main/src/webui_frontend.py) and require `uvicorn` to run.

### What file should I check to customize report formats?

Report formatting is controlled by Jinja2 templates stored in the `templates/` directory. Check `templates/report_markdown.j2` for standard output formatting or `templates/report_wechat.j2` for WeChat-specific layouts, both referenced by [`src/report_renderer.py`](https://github.com/ZhuLinsen/daily_stock_analysis/blob/main/src/report_renderer.py).