Skip to content

AGENTS.md

Latest commit

 

History

History
32 lines (26 loc) · 960 Bytes

AGENTS.md

File metadata and controls

32 lines (26 loc) · 960 Bytes
Raw

Repository Guidelines

Project Purpose

This repository is a generic documentation crawler:

  1. Crawl a target docs site and store markdown files.
  2. Build a local HTML viewer with sidebar navigation + markdown content panel.

Main Files

  • docs_crawler.py: core CLI (init / crawl / build-site / run / status / preview)
  • crawler_config.json: target site and runtime settings
  • run_crawler.bat: one-click Windows entrypoint
  • tests/test_docs_crawler.py: unit tests

Output Workspace

Generated data is written to .site_sync/ (configurable):

  • source_md/
  • manifests/source_manifest.json
  • source_site/index.html
  • reports/

Development Commands

python docs_crawler.py --config crawler_config.json run
python docs_crawler.py --config crawler_config.json preview --port 8777
python -m unittest discover -s tests -p "test_*.py" -v

Style

  • Python 3.10+
  • PEP 8, 4 spaces
  • Keep changes focused and reversible