docs - Documentation Viewer

Description

The docs command displays comprehensive documentation for AccordionShell commands. It provides a formatted, easy-to-read view of command syntax, options, examples, and detailed explanations. You can view either an index of all available commands or detailed documentation for a specific command.

Syntax

docs [command] [options]

Parameters

Parameter	Required	Description
`command`	No	Specific command to show documentation for. Omit to show the documentation index.

Optional Options

Option	Short	Description	Default
`--pager`	`-p`	Enable pager mode for long documentation (press any key to continue after each page)	`false`

Examples

View Documentation Index

Shows a complete list of all available commands with brief descriptions:

docs

View Specific Command Documentation

docs init

docs pmbus

docs i2c

Useful for lengthy documentation that doesn't fit on one screen:

docs pmbus --pager

docs -p firmware

Available Commands

The following commands have comprehensive documentation available:

alias - Manage alias configuration files
audio - Generate audio signal files
conf - Configure channel properties
discover - Discover Accordion systems on the network
docs - Documentation viewer (this command)
exit - Exit the application
firmware - Update firmware and manage services
general - General operations including Python wrapper generation
get - Get channel values with performance metrics
i2c - Perform I2C bus operations
init - Initialize connection to Accordion hardware
list - List all channels and their values
media - Upload, download, and manage media files
module - Load, unload, and manage modules
num - Work with numeric result channels
pmbus - Program and manage PMBus devices
reset - Reset the Accordion system
set - Set channel values
stream - Handle byte stream channels
wait - Wait for channel value conditions

Output Format

Documentation is rendered with formatted markdown including:

Headers - Color-coded by level (H1: yellow, H2: cyan, H3: green)
Code blocks - Syntax-highlighted command examples
Tables - Formatted option tables and data grids
Lists - Bullet points and numbered lists
Emphasis - Bold and italic text for important information

When using --pager mode:

Documentation displays one screen at a time
Press any key to continue to the next page
Press 'q' to quit viewing and return to the prompt
Useful for long documentation files that exceed screen height

Behavior

Checks if the docs directory exists in the application folder
If no command is specified, displays the documentation index (as-index.md)
If a command is specified, looks for the corresponding as-<command>.md file
Renders the markdown content with formatting and color
If pager mode is enabled, pauses after each screen-full of content
If documentation is not found, displays list of available commands

Documentation Files

Documentation files are located in the docs subdirectory of the application and follow the naming convention:

as-<command>.md

For example:

as-init.md - Documentation for the init command
as-pmbus.md - Documentation for the pmbus command
as-index.md - Documentation index (shown when no command specified)

Quick Help vs. Comprehensive Documentation

AccordionShell provides two levels of help:

Method	Command	Content	Use Case
Quick Help	`<command> --help`	Brief syntax and options	Quick reference, command-line usage
Comprehensive Docs	`docs <command>`	Detailed explanations, examples, use cases	Learning, troubleshooting, best practices

Quick Help Example

init --help

Shows brief syntax overview.

Comprehensive Documentation Example

docs init

Shows detailed explanation, connection options, examples, and troubleshooting tips.

Tips

Use docs without arguments to browse all available commands
The documentation viewer works offline - no internet connection required
Documentation files can be edited if you need to add custom notes
Use pager mode (-p) when viewing documentation on small terminal windows

Error Messages

Message	Description
"Documentation directory not found"	The `docs` folder is missing from the application directory
"Documentation not found for command 'X'"	No documentation file exists for the specified command

exit - Exit the application after viewing documentation
help - Command-line help (shows brief command list)

Use Cases

Learning the Tool: Explore all commands and their capabilities
Reference: Look up syntax and options for specific commands
Examples: Find working examples for complex operations
Troubleshooting: Understand expected behavior and common issues
Offline Access: View detailed help without internet connectivity