Documentation — @geoleaf/core
Complete documentation for the
@geoleaf/corepackage.
Generated API (TypeDoc)
- API reference — geoleaf.dev/docs/api/ — auto-generated from the TypeScript types. Can be regenerated locally with
npm run docs:api(output indocs/api/, which is a build artifact and is not committed)
Main guides
- GETTING_STARTED.md — quick start (5 min)
- USER_GUIDE.md — complete user guide
- QUICKSTART_TUTORIAL.md — a profile built step by step
- PROFILE_JSON_REFERENCE.md — reading guide of a profile's JSON files
- API_REFERENCE.md — API reference (80+ methods)
- ARCHITECTURE_GUIDE.md — architecture, boot sequence, modules
Advanced reference
- PROFILE_JSON_REFERENCE.md — profile JSON schema (120+ parameters)
- schema/README.md — the profile JSON Schemas shipped with the package (
@geoleaf/core/schemas), which file each one judges, and how to validate a profile
Development
- CONTRIBUTING.md — conventions and contribution guide
Other
- COOKBOOK.md — practical recipes
- FAQ.md — frequently asked questions
- NOTICE.md — licenses and attributions
- INDEX_CORE.md — complete documentation index