Welcome to the documentation hub for the Luther Platform!
This repository provides comprehensive guides, language references, onboarding information, connector details, middleware integration, and more to support users and developers working with the Luther Platform.
The same guides are published at docs.luthersystems.com, where the ELPS examples run in your browser. That site is where the guides are edited. Each merge there regenerates the pages listed in .site-sync/manifest.json and opens a "Sync the guides" PR here, so the two copies stay the same.
To change one of those pages, edit it in luthersystems/frontpage-docs src/content, not here: a hand edit here would be lost at the next sync, and the site sync guard check refuses it. The other pages (this README, the section indexes, onboarding, FAQ, glossary) are edited here.
- README.md: Repo and docs overview
- release-notes.md: Release notes for substrate, ELPS and the other platform components
- announcements.md: Major platform release announcements
- security-notice-emsign.md: Security notice for the eMudhra (emSign) CA distrust, and the image versions to use
- known-issues.md: Known issues and their workarounds
- faq.md: Frequently asked questions
- glossary.md: Glossary of key terms used throughout the platform
- contact-us.md: How to reach support or provide feedback
- Path:
common-operation-script/ - Overview and in-depth documentation for process scripts and logic
- Start with common-operation-script/README.md
- Path:
connectors/ - Documentation for available system connectors and integration points
- Start with connectors/README.md
- Path:
operations/ - Guides for running a Luther network: peer ledger storage and Fabric ledger snapshots
- Start with operations/README.md
- Path:
middleware/ - Guides for middleware services, such as Martin, and integration patterns
- Start with middleware/README.md
- Path:
onboarding/ - Step-by-step onboarding for new users, including environment setup, cloud details, and best practices
- Start with onboarding/README.md
assets/: Images, logos, and other assets (some may be excluded from this repo)
- New to Luther? Begin in onboarding/ and check out the Quickstart guides in common-operation-script/quickstart/.
- Building process logic? See common-operation-script/ellipse-dev-language/.
- Integrating with external systems? Explore connectors/.
For further questions, see the FAQ or reach out via Contact Us.