Documentation Index

A complete map of Stellium’s documentation. The hub for development is /CLAUDE.md.

For coding agents / contributors — docs/development/

🤖 The docs/development/ set is primarily for coding agents. Hello, Claude! It’s a durable technical reference so an agent doesn’t have to re-learn the API and architecture each session. Human contributors are welcome to use it too.

Doc	Purpose	Status
development/README.md	Reading order + scope of the agent docs	Current
development/ARCHITECTURE.md	Mental model, layer map, dependency rules, .calculate() flow	Current
development/CHART_BUILDING.md	Native/Notable, ChartBuilder, CalculatedChart, config, registries	Current
development/ENGINES.md	Ephemeris, houses, aspects, orbs, dignities, patterns, profections, …	Current
development/COMPONENTS_AND_ANALYSIS.md	Components, analysis/DataFrames, IO, caching, utils	Current
development/VISUALIZATION_INTERNALS.md	SVG pipeline, coordinates, layers, themes/palettes, dial/vedic/atlas	Current
development/PRESENTATION_INTERNALS.md	ReportBuilder, sections, renderers	Current
development/SUBSYSTEMS.md	Multi-chart, returns, electional, planner, Chinese/BaZi, CLI	Current
development/EXTENDING.md	How to add engines/components/analyzers/layers/themes/sections	Current

User-facing guides — docs/

Doc	Purpose
README.md	Docs landing page
index.md	Sphinx/ReadTheDocs entry
VISUALIZATION.md	Drawing charts (themes, palettes, presets)
REPORTS.md	Generating terminal/markdown/PDF reports
CHART_TYPES.md	Natal, synastry, transits, returns, composite, etc.
THEME_GALLERY.md / PALETTE_GALLERY.md	Visual catalogs
DIAGNOSTICS.md	Logging & warnings — silencing, filtering, capturing, configure_logging
LOCATIONS.md	Where Stellium reads and writes — ephemeris vs. cache dirs, STELLIUM_EPHE_PATH / STELLIUM_CACHE_DIR, portable & read-only-$HOME installs
options_list.md	Complete configuration reference
api/index.md	API reference

Astrology guides — docs/astrology/

Practitioner-facing teaching guides: the astrology itself, not the API.

Doc	Purpose
astrology/RECTIFICATION.md	Birth-time rectification & sect recovery — what it is, how to use analyze_sect, and how not to (the ill-posed-inverse guardrails)

Methodology & sources — docs/methodology/

Scholarly provenance: what Stellium’s traditional techniques implement and on whose authority. Separate from the practitioner-facing astrology guide (docs/astrology/, teaching) and the code reference (docs/development/).

Doc	Purpose
methodology/README.md	Traditional Methods & Sources — per-technique defaults, citations, contested forks, and simplifications
methodology/research/	The raw source-verification reports (ZR, Firdaria, planetary years) kept as provenance

Historical / superseded

Doc	Note
ARCHITECTURE.md	Superseded (Nov 2025). Concepts still valid; for current API use docs/development/.

Top-level references (repo root)

• /README.md — project overview & quick start

• /CLAUDE.md — development hub for agents

• /CONTRIBUTING.md — contribution workflow

• /CHANGELOG.md — release history

• /TODO.md — roadmap