Manage Documentation — Platform Admin

Overview

Platform Admins control the documentation available on the public website and within the dashboard. Documentation is organized into spaces (topic areas) and pages within each space. Both Arabic and English versions must be complete before a page can be published.

Documentation Spaces

A documentation space is a top-level category (e.g. "Platform Admin", "Tenant Admin", "Mobile API", "Billing", "FAQ"). Each space contains multiple pages.

Spaces can be:

• Public: Visible to anonymous visitors on the public website.
• Internal-only: Accessible only to authenticated dashboard users — never shown on the public website.

Viewing Documentation

1. Open Documentation from the dashboard navigation.
2. The space list shows all spaces, their publication status, and the number of pages in each.
3. Click a space to view its pages.

Editing a Page

1. Select the space and click the page name.
2. Edit the Arabic content and English content in the editor.
3. Click Save as Draft to save without publishing.
4. Click Publish to make the content live on the public website.

A page is not published on the public website until you explicitly click Publish. Draft content is visible only to dashboard users.

Publishing Rules

• Both Arabic and English content must be non-empty to publish.
• Publication rejects a missing bilingual value or a title/content value whose trimmed text is exactly TBD, case-insensitively. It does not reject embedded text such as Introduction - TBD; editorial review must detect partial placeholders and other incomplete wording.
• Internal-only spaces cannot be published to the public website regardless of individual page status.

Creating a New Page

1. Open a space.
2. Click Add Page.
3. Enter the page slug (URL-friendly identifier), Arabic title, and English title.
4. Add Arabic and English content.
5. Click Save as Draft or Publish.

Page slugs must be unique within a space and cannot be changed after creation.

Managing Space Visibility

1. In the space list, click Settings next to a space.
2. Toggle Public on Website to control whether the space appears on the public website.
3. Click Save.

Setting a space to internal-only immediately removes it from the public website listing, even if individual pages were published.

Important Notes

• Reordering pages: Drag the pages within a space to reorder them. The sort order is reflected on the public website.
• Unpublishing a page: Click Unpublish on a published page to remove it from the public website without deleting the content.
• All publish and unpublish actions are logged with the acting admin's identity and timestamp.