-
-
Notifications
You must be signed in to change notification settings - Fork 97
Open
Description
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 tabledocs/api/types.md— All TypeScript types documented
-
Remaining Guides completed:
docs/guides/custom-settings.md— Settings examples with live demosdocs/guides/custom-symbols.md— CUSTOM_SYMBOL_FN hook exampledocs/guides/multiple-charts.md— Two charts on one pagedocs/guides/click-events.md— Click areas and DOM integration
-
Framework Integration Guides (bonus if not already included):
docs/guides/frameworks/react.md— useRef + useEffect patterndocs/guides/frameworks/vue.md— ref + onMounted patterndocs/guides/frameworks/angular.md— @ViewChild + ngAfterViewInit pattern- Each with copy-pasteable component examples and SSR notes
-
docs/changelog.mdcreated:- 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
titlefield -
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)
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels