Introducing Our Engineering Hub
Good docs aren't a nice-to-have β they're the difference between a developer choosing your platform or closing the tab.
Today we're launching engineering.shellapps.com, our centralised documentation and engineering hub.
What's Inside
Platform Docs
Full API references and integration guides for every ShellApps service:
- Auth β Registration, login, 2FA setup, OAuth flows, token management
- Experience Platform β Event tracking, analytics, feature flags, error tracking, feedback collection, theming, and translations
- Toolshed β Integration connectors and webhook management
- Design System β Component library and design tokens
Norman AI Docs
Norman is our conversational AI platform. The engineering hub covers all three components:
- Norman Engine β The core NLP and conversation routing system
- Norman Agent β Autonomous task execution and tool integration
- Norman Chat β Embeddable chat widget for websites and apps
Guides and Architecture
Beyond API references, we've included architecture overviews, data flow diagrams, and step-by-step guides for common integration patterns.
Built with Nextra
The engineering hub is built on Nextra, a documentation framework built on Next.js. We chose it for three reasons:
- MDX support β Write docs in Markdown with embedded React components when we need interactive examples
- Search β Built-in full-text search across all docs, no extra service needed
- Sidebar navigation β Auto-generated from the file structure, keeps everything organised as we grow
Living Documentation
These docs aren't a one-time effort. Every pull request that changes an API includes a corresponding docs update. Our CI pipeline checks for broken links and validates code examples.
We've also added a changelog page that tracks every significant platform change, so you'll always know when something new ships.
What's Coming
Over the next few weeks, we're adding:
- Interactive API explorer β Try API calls directly from the docs
- SDK quickstart generators β Pick your framework, get a working starter project
- Community section β Share integrations, ask questions, and vote on feature requests
Explore the hub at engineering.shellapps.com. If something's missing or unclear, there's a feedback link on every page.