📘 Documentation Portal Overview

The Documentation Portal in All Things API (ATA) is a centralized workspace for creating, managing, publishing, and sharing API documentation. It supports collaborative workflows, customization, multilingual support, and seamless integration. This portal empowers developers, product managers, and technical writers to deliver accessible and up-to-date API documentation for both internal and external consumers.

1. Documentation Products and Versions

Each Product represents a single API or API suite.
Each product can have multiple Versions, supporting version-controlled documentation.

Version States

Draft: In-progress documentation not visible to consumers.
Published: Public or team-facing, depending on sharing settings.

✅ This structure supports iterative updates, team reviews, and long-term lifecycle management.

2. Creating and Editing Documentation

Users can create documentation pages using one of three editors:

Markup Editor Write in Markdown or HTML/CSS. Ideal for developers or technical content authors.
Designer Editor A no-code, drag-and-drop interface for visual content creation. Best for product teams or non-technical contributors.
External Page Link to externally hosted documentation.

These options ensure flexibility for both technical and non-technical contributors.

3. Version Settings and Customization

Each version supports a rich set of configuration options:

General Info

Set the URL path
Choose supported programming languages
Enable public preview links

Appearance Settings

Upload custom logo and favicon
Configure portal title
Toggle light/dark themes
Enable/disable bottom navigation
Customize color themes (primary, secondary, header/footer)

Add Icons, Buttons, Links, and Dropdowns
Configure link behavior, styling, and preview visibility

These settings offer white-labeling and branding alignment capabilities.

4. Multilingual Support and Translation

Documentation can be authored and viewed in:

English
Spanish
Arabic
Chinese
Hindi

Features

Side-by-side editing for languages
Language tabs in editor for quick switching
Sync indicators:
- 🟡 Yellow: Translation out-of-sync
- 🟢 Green: Translation is current
Sync Now button to align translations with latest English version

This enables global content delivery with consistent accuracy.

5. Importing and Exporting Versions

Export as .json or .zip for storage, reuse, or migration
View, download, or delete from Exported Portal tab
Import allows restoration or duplication of any exported version

Useful during cross-team collaboration, backups, or product rebranding.

The Documentation Portal in ATA provides flexible and secure options for sharing documentation versions with various stakeholders, both internal and external.

Individuals Share documentation directly with specific users via their email address. This is useful when seeking feedback from collaborators, external partners, clients, or subject matter experts who are not part of the organization.
Organizations Share access with an entire company or team using:
- Company ID: Grants access to all users under a specific organization.
- Team ID: Limits access to a designated team within that company.

This supports structured sharing aligned with your organization’s hierarchy or external vendor relationships.

⚙️ Configurable Options

When sharing documentation, the following settings can be configured:

Expiry Date Set a specific date on which the access will automatically expire. Ideal for time-bound reviews, vendor evaluations, or limited-time access during sprints.
No Expiry Leave the access open indefinitely until manually revoked. Suitable for long-term collaborators or internal team members who need persistent access.
Optional Notes Add a personalized message or context for the recipient. This helps in clarifying the purpose of sharing, expected actions, or additional instructions.

Easily monitor sharing activities through two dedicated dashboards:

Shared With Me Lists all documentation versions that have been shared with you by others, enabling quick access to external content or reviews you’ve been invited to.
Shared By Me Shows all versions you have shared with others, along with recipient details, sharing status, and expiry configurations. Useful for managing permissions and revoking access when needed.

✅ This structured sharing mechanism ensures secure and role-based documentation distribution while enabling traceability, controlled collaboration, and audit readiness.

7. Domain Configuration

Add custom domains like docs.company.com
View metadata: product association, creator, status
Edit or delete via action menu

Perfect for public-facing, branded documentation portals.

8. “Ask AI” Support

Enable an AI-powered assistant on published versions:

Users can ask natural language questions
AI responds using existing documentation content

Improves onboarding, reduces support tickets, and provides instant help.

9. Page and Tab Configuration

Arrange pages hierarchically
Group content under tabbed sections
Edit, rename, or delete individual pages
Use any of the three editors for page creation

Ensures a structured and navigable documentation experience.

10. User Access, Preview, and Publishing

Use Preview to simulate external user view
Finalized documentation can be:
- Saved for continued edits
- Published for external access

Maintains version control and quality assurance before public release.

✅ Summary

The Documentation Portal in All Things API (ATA) is a robust, customizable solution for API documentation. Whether you need to manage multilingual content, perform version control, embed custom domains, or offer AI-powered help, ATA’s Documentation Portal gives you full control while staying user-friendly for all contributors.