Skip to content

Commit 018d776

Browse files
Simplify ALDashboard overview and remove stubs
1 parent 9f45852 commit 018d776

File tree

1 file changed

+5
-39
lines changed

1 file changed

+5
-39
lines changed

docs/components/ALDashboard/aldashboard_overview.md

Lines changed: 5 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -7,29 +7,10 @@ slug: /components/ALDashboard/overview
77

88
ALDashboard is a collection of tools to help administer a Docassemble server and debug interviews. It provides utilities for package management, server maintenance, translation workflows, and debugging tools specifically designed for the Document Assembly Line ecosystem.
99

10-
## Key Features
10+
:::warning This page is a stub
1111

12-
ALDashboard provides several categories of functionality:
13-
14-
### Package Management
15-
- Create and manage Docassemble packages
16-
- Scan and analyze package contents
17-
- Automated package building and deployment tools
18-
19-
### Translation and Internationalization
20-
- Translation workflow management
21-
- Multi-language support for interviews
22-
- Translation validation and quality assurance
23-
24-
### Server Administration
25-
- Server maintenance utilities
26-
- Package installation and updates
27-
- System diagnostics and monitoring
28-
29-
### Document Processing
30-
- DOCX file validation and processing
31-
- Attachment validation tools
32-
- Document template analysis
12+
We have not yet documented the key modules in the ALDashboard.
13+
:::
3314

3415
## Main Modules
3516

@@ -44,25 +25,10 @@ ALDashboard consists of several Python modules, each providing specific function
4425
- **validate_docx.py** - DOCX validation utilities
4526
- **validate_attachment.py** - Attachment validation tools
4627

28+
Some of this functionality is useful outside of the ALDashboard. `project_maintenance.py` is specifically a tool to run from the commandline and is not available as a "widget" you can interact with from the Docassemble frontend.
29+
4730
## Installation
4831

4932
ALDashboard is typically installed as part of the Document Assembly Line setup:
5033

51-
```bash
52-
pip install docassemble-ALDashboard
53-
```
54-
55-
Or install from the Docassemble package management interface by searching for "ALDashboard".
56-
57-
## Usage
58-
59-
ALDashboard provides both programmatic APIs and interview-based interfaces for server administration. Most functionality is accessed through the Docassemble web interface after installation.
60-
61-
## Related Documentation
62-
63-
- [Assembly Line Project Architecture](/docs/get_started/al_project_architecture)
6434
- [Installation Guide](/docs/get_started/installation)
65-
66-
## Repository
67-
68-
The ALDashboard source code is available at: https://github.com/SuffolkLITLab/docassemble-ALDashboard

0 commit comments

Comments
 (0)