Skip to content

Conversation

@shweta2101
Copy link

DevBoard Task

#2494 — Update ASR usage guide that includes Longform JSON 3.0 support


Description

This PR updates the AVIV ScoutRoute Usage Guide under the TDEI documentation to incorporate details for Longform Quest Definitions (JSON v3.0).
The new guide provides step-by-step instructions on defining, loading, and verifying longform quests using the TDEI Workspaces interface.
The update ensures alignment with the latest schema structure and the current behavior of the AVIV ScoutRoute application.


Changes Made

  • Added new guide:
    tdei/producers/workspaces/aviv-scoutroute/long-form/guides/quests-guide.md

  • Updated index.md under Long Form Quest Definition Guides to reference the new guide.

  • Added the following screenshots under docs/resources/images/aviv-scoutroute/long-form/:

    • 01-datasets.png
    • 02-open-in-workspaces.png
    • 03-create-workspace.png
    • 04-verify-workspace.png
    • 05-adding-quests.png
    • 06-external-apps.png
    • 07-custom-imagery.png
  • Linked all screenshots with correct relative paths (../../../../../../resources/images/...) for MkDocs rendering.

@uw-amy-bordenave
Copy link
Collaborator

There is a scope issue here: The newly added guide covers much more than its title implies. Please split out the sections into different markdown files - one for "Creating a Workspace in TDEI Portal", one for "Adding Long Form Quest Definition to a Workspace", one for "Configuring Custom Imagery", etc.

@shweta2101
Copy link
Author

Thanks for the review! I've refactored the Long Form Quests content as suggested.

Changes made:

  • Split the original guide into separate topic-focused markdown files:
    • creating-workspace.md
    • adding-longform-quests.md
    • configuring-custom-imagery.md
  • Added a new overview/index page:
    • long-form-overview.md
      This page links all Long Form guides together for easier navigation.
  • Removed combined content from the previous single guide.

Let me know if you'd like any further changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants