Skip to main content

Quick Start Video Walkthrough

This page provides a video walkthrough of the complete aprity setup process. In under 5 minutes, you will see every step from installation to downloading your first generated documentation.

Video​

Video placeholder: Quick Start with aprity (5 minutes)
Embed URL: https://www.youtube.com/embed/VIDEO_ID_HERE

:::info Video coming soon The quick start video walkthrough is currently in production. In the meantime, follow the written guides below. :::

What the video covers​

The walkthrough follows the complete getting started flow in five steps:

1. Install the managed package (0:00 - 1:00)​

  • Navigate to the aprity listing on AppExchange
  • Click Get It Now and select your org
  • Choose "Install for All Users"
  • Verify the installation in Setup

See: Installing the Managed Package

2. Register your organization (1:00 - 1:45)​

  • Open the aprity app from the App Launcher
  • Enter the activation code
  • Confirm registration completes

See: Registering Your Organization

3. Configure JWT authentication (1:45 - 3:30)​

  • Download the certificate from aprity
  • Create a Connected App in Salesforce Setup
  • Upload the certificate and configure OAuth scopes
  • Copy the Consumer Key back into aprity
  • Run the connection test

See: Configuring JWT Bearer Authentication

4. Run your first scan (3:30 - 4:15)​

  • Go to the Generate tab
  • Select English and Markdown + HTML formats
  • Click Generate and observe the progress

See: Running Your First Scan

5. Download documentation (4:15 - 5:00)​

  • Go to the Analyses tab
  • Find the completed scan
  • Download the Markdown and HTML output
  • Open and review the generated documentation

See: Downloading Generated Documentation

Written guides​

If you prefer step-by-step written instructions, follow these guides in order:

  1. Prerequisites
  2. Installing the Managed Package
  3. Registering Your Organization
  4. Configuring JWT Bearer Authentication
  5. Running Your First Scan
  6. Downloading Generated Documentation

Need help?​

If you run into issues during setup, check the Troubleshooting section or contact support at support@aprity.ai.