Skip to content

[Phase 2] Write remaining documentation pages #100

@afucher

Description

@afucher

Complete all remaining documentation pages: API reference, guides, contributing, and changelog.

Deliverable

A comprehensive documentation site with 20+ pages covering the full public API, advanced guides, and contribution guidelines.

Acceptance Criteria

  • API Reference section completed:

    • docs/api/chart.md — Chart class (constructor, radix, scale, calibrate)
    • docs/api/radix.md — Radix class (all draw* methods, aspects, transit)
    • docs/api/transit.md — Transit class (all methods, animate)
    • docs/api/aspect-calculator.md — AspectCalculator (radix, transit methods)
    • docs/api/zodiac.md — Zodiac utility (getSign, getHouseNumber, etc.)
    • docs/api/settings.md — Complete Settings reference table
    • docs/api/types.md — All TypeScript types documented
  • Remaining Guides completed:

    • docs/guides/custom-settings.md — Settings examples with live demos
    • docs/guides/custom-symbols.md — CUSTOM_SYMBOL_FN hook example
    • docs/guides/multiple-charts.md — Two charts on one page
    • docs/guides/click-events.md — Click areas and DOM integration
  • Framework Integration Guides (bonus if not already included):

    • docs/guides/frameworks/react.md — useRef + useEffect pattern
    • docs/guides/frameworks/vue.md — ref + onMounted pattern
    • docs/guides/frameworks/angular.md@ViewChild + ngAfterViewInit pattern
    • Each with copy-pasteable component examples and SSR notes
  • docs/changelog.md created:

    • Manually maintained starting from v3.0.2
    • Format: ## [3.0.2] – YYYY-MM-DD with Added/Fixed/Changed sections
    • Link to GitHub Releases for older history
  • `docs/contributing.md" completed:

    • Bug reporting (link to issue templates)
    • Symbol requests
    • PR workflow
    • Dev setup (npm ci, npm test, npm run build)
    • Code style summary
    • Ko-fi and GitHub Sponsors links
    • Link to CODE_OF_CONDUCT.md
  • All pages have frontmatter with title field

  • Sidebar config (astro.config.mjs) updated to include all new pages

  • No broken links (internal or external)

  • Spelling and grammar checked

  • Search index builds and includes all pages

Related Plan Section

docs-plan.md §4.3 (Page-by-Page Content Spec)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions