Living Manual Documentation

This is the Living Manual documentation, and it is running on Living Manual. Every page below, the search, and the support docent were built from one PDF, the same way your manual would be.

Browsing and searching the documentation is free and needs no account. The support docent and support tickets need an active Living Manual Pro license.

Get support Send feedback

Contents

  1. Overview
  2. 1. What Living Manual is
    1. 1.1 The two plugins
    2. 1.2 Where your content lives
  3. 2. Installing Living Manual
    1. 2.1 Requirements
    2. 2.2 Installing the free core
    3. 2.3 Installing Living Manual Pro
    4. 2.4 The setup wizard
  4. 3. Creating a manual
    1. 3.1 Add a document
    2. 3.2 What happens next depends on Pro
    3. 3.3 Getting a good result
  5. 4. Reading a manual
    1. 4.1 Browsing
    2. 4.2 Searching
    3. 4.3 Access
  6. 5. The AI docent
    1. 5.1 What makes it different from a general chatbot
    2. 5.2 How it finds an answer
    3. 5.3 Cost
    4. 5.4 When the docent says it does not know
  7. 6. Insights
    1. 6.1 What to do with it
  8. 7. Licensing
    1. 7.1 Activating
    2. 7.2 Deactivating
    3. 7.3 Revalidation
    4. 7.4 What happens when a license lapses
    5. 7.5 Common activation problems
  9. 8. Updating a manual
    1. 8.1 Re-ingest
    2. 8.2 Replacing the source document
    3. 8.3 Deleting
  10. 9. Permissions
    1. 9.1 Changing the required capability
    2. 9.2 Read-only viewers
  11. 10. Troubleshooting
    1. 10.1 Manual pages return 404
    2. 10.2 The manual’s URL stopped resolving
    3. 10.3 The ingest produced no sections, or almost none
    4. 10.4 The ingest failed
    5. 10.5 The ingest seems stuck
    6. 10.6 The docent is not there
    7. 10.7 The docent will not answer a question the document covers
    8. 10.8 Emails from Living Manual are not arriving
  12. 11. Getting help
    1. 11.1 Documentation
    2. 11.2 Feedback, for everyone
    3. 11.3 Support tickets, with a license
    4. 11.4 What to include in a ticket
  13. 12. Privacy and data
    1. 12.1 What stays on your server
    2. 12.2 What the free core sends, and when
    3. 12.3 What Living Manual Pro sends
    4. 12.4 Deleting your data