@SciFlow Library Documentation¶
SciFlow ships as a set of npm packages (web components, core runtime, schema) plus the tooling you need to extend or contribute to the editor. This site is split into two pillars:
- User Guide – for development teams embedding the
<sciflow-editor>component or talking directly to the core APIs. - Developer Guide – for contributors working inside this monorepo with Nx, Vitest, and MkDocs.
Use the navigation on the left to jump directly into either guide, or start with the summaries below.
Choose Your Path¶
| If you want to… | Start here |
|---|---|
| Embed the editor, wire reference lists, or call commands from your app | User Guide |
| Hack on the editor, run Nx targets, or extend the schema/features | Developer Guide |
| Look up package entry points or schema exports | Reference |
New to the project?
Follow the User Guide → Getting Started chapter first. It walks through registry configuration, installing the packages, running the demo, and embedding the web components.
Contributing internally
The Developer Guide references the same commands we run in CI. If you can run npx nx run-many -t lint test build typecheck locally, you’re ready to send a PR.
What’s Inside¶
- User Guide – Install, configure, and customize the provided components. Includes recipes for supplying your own reference lists, file APIs, and document outlines.
- Developer Guide – Architecture overview, command system deep dive, local workflows, and documentation tooling notes.
- Reference – Package inventory, schema pointers, and release notes for quick lookups.
Everything in this documentation is private to the project right now, so feel free to iterate quickly. Use admonitions (!!! note, !!! warning, etc.) when adding new material to keep important guidance visible.***