Apex Designer Documentation
What's New
Getting Started
Projects
Business Objects
Processes
User Interfaces
App Behaviors
Files
Dependencies
Project Settings
Libraries
Patterns and Best Practices
App Showcase

Apex Documentation Library

Add documentation pages to your app or build a whole documentation site.

Blank Profile Image
Written by David Knapp
Updated 9 months ago
Less than a minute read

The Apex Documentation Library makes it easy to add documentation to your app or build a documentation site. The Apex Designer Documentation site (this site) is built and managed using this library.

Features

Here are just a few of the features of this library:

  • Easy to use WYSIWYG editor with full access to the HTML
  • Page hierarchy with automatic table of contents and child pages component
  • Image management
  • Page lifecycle management including draft, ready for review, published and deleted
  • App version effectivity on pages
  • Integrated full text search
  • Automatic generation of What's New
  • SEO optimization by serving static pages to crawlers

Deployment Patterns

For single instance deployment, you can use the Apex Documentation Library directly in your app and host the pages as part of your app. You author content on your production instance and can use the App Version effectivity to develop pages for new app versions that are not yet in production.

For multi instance deployment, you can create a documentation site app (like this one) that is deployed separately from your app. The App Version effectivity handles the fact that different app instances may be at different app versions.

On the Roadmap

Here are a few of the things on the roadmap:

  • Client library to provide contextual documentation directly in your app
  • Track read pages for users and show unread marks based on app context
  • Automatic Glossary of Terms

If there are other things you would like to see in this library, just click the "Ask a Question" button and tell us about it.

Powered by Apex Designer
Terms of ServicePrivacy Policy
© 2017-2022 Apex Process Consultants