Command Line Tool Documentation

Summary

Create a document that provides maintainers and customers with navigating DDS documentation and tools

Tasks

Task Name	Owner	Start Date	Status	Description	Comments
Generate command line tool index document	Matthew	01/07/2026	Started	Create the initial code to generate a command line tool index document	TBD

Team

• Bernardo Garza
• Geunhyung Ban

Meetings

01/07/2026 Meeting

Objectives

• What should be in the documentation and how should it be organized
• What should the document be named (dds-getting-started.htm?)
• Where will the document lives (/desk?)
• Go over the python script and the document it generates

Meeting Notes

• Index Document
  • Name should likely be "deos-package-index.htm"
  • Should be kept as its own document

• Command Line Tool Documents
  • Name should likely be "command-line-tool-index.htm"
  • New document that lists ONLY packages with files in "/desk/bin"
  • Start off with having two sections for each package
  1. Tools
  2. Documentation
  • After the initial documentation is created, G can look into how to add useful information
    • Parse htm document for a tool and grab the overview section, if it does, put the overview into the table
    • If overview sections do not exist in the htm files for tools, considering adding them