Visuals like images and videos make your documentation much more engaging and easier to understand. This guide explains how to upload, manage, and embed media assets across your documentation projects.
flowchart LR
A[Upload Media] --> B[Update Metadata]
B --> C[Embed in Page]
C --> D["Serve to Readers"]The Asset Lifecycle
Managing media in your documentation follows a simple, straightforward process. Every asset is securely tied to your specific documentation project.
- 1
Upload your file
Add your image or video to your documentation project. Once uploaded, the system securely stores the file and assigns it a unique Asset ID.
- 2
Organize with metadata
Update the asset's metadata—such as its title, description, or alt text—to keep your media library organized and accessible.
- 3
Embed in your pages
Insert the asset into your document entries. The system uses a dedicated, secure URL to serve the file directly to your readers.
Managing Your Media Library
As your documentation grows, keeping track of your images and videos becomes essential. The system provides several ways to manage your media library effectively.
| Capability | What it does |
|---|---|
| Browse all assets | View a complete list of all media files currently uploaded to your documentation project. |
| View asset details | Retrieve specific information about a single asset, including its file size, type, and upload date. |
| Update metadata | Modify an asset's properties (like its name or alt text) without needing to re-upload the underlying file. |
Always add descriptive metadata to your assets. Good alt text improves accessibility for users with screen readers and helps you search your media library faster.
Embedding Assets
When you are ready to use an image or video, you don't need to worry about hosting it externally. The system automatically generates a secure file URL for every uploaded asset.
When you embed an asset into a documentation entry, the platform calls the internal file server to display the media seamlessly to your readers.
Because assets are scoped to your specific organization and documentation project, they remain secure and cannot be accessed by unauthorized external projects.
Deleting Assets
If an image is outdated or no longer needed, you can delete it from your project to save space and keep your library clean.
Deleting an asset is permanent. If you delete an asset that is still embedded in a published documentation page, readers will see a broken image link. Always ensure an asset is removed from your pages before deleting it from the library.
Frequently Asked Questions
Can I update an image without changing its URL?
Yes! You can update the asset's metadata or replace the underlying file while keeping the same Asset ID. This means you won't need to go back and update the links in all your documentation pages.
Where do I organize my pages?
Assets are embedded inside your documentation entries. You can group these entries into sections and reorder them to build your perfect documentation hierarchy.