Documentation — Tenant Admin
Overview
Survanta has two documentation experiences that must not be conflated. Public documentation is the website /docs index and /docs/{spaceCode}/{slug} pages, limited to active, website-visible spaces and published pages. Contextual dashboard HELP resolves the current controller/action through an active help-route mapping and can read internal dashboard-help content after mirroring the target page's authorization.
Browsing Documentation
- Open Documentation or
/docsto browse public website documentation. - The public index shows only active spaces marked visible on the website and their published pages.
- Click the contextual HELP button on a dashboard page for route-specific internal guidance, when a mapping exists.
- HELP rechecks the target page's authorization; it returns forbidden or not found rather than exposing an unauthorized or unmapped page.
Language Switching
The documentation viewer respects your current language setting. Use the language toggle to switch between Arabic and English versions of any page.
What Documentation Covers
The Survanta documentation includes guidance on:
- Platform Admin: Managing tenants, users, plans, billing, integrations, and website.
- Tenant Admin: Managing users, permissions, storage, billing requests, and integration clients.
- Mobile API: How researchers and mobile users authenticate and complete surveys.
- Website User: How to register, manage requests, and use the custom plan builder.
- Security: Permissions model, tenant isolation, tokens, and file safety.
- Billing: Plans, invoices, subscription management, and limit increase requests.
- FAQ: Common questions grouped by user type.
Internal-Only Documentation
Internal spaces, especially dashboard-help, are not public /docs content. Contextual HELP reads its mapped internal page with publication not required, but still requires a dashboard identity and mirrored target authorization. An absent mapping causes the HELP button not to render; button visibility itself is not an authorization control.
Feedback
If you find documentation that is unclear or missing information, contact your Platform Admin to request an update. Documentation pages are managed by Platform Admins from the platform-side documentation management section.