62 lines
1.6 KiB
Markdown
62 lines
1.6 KiB
Markdown
# AIOS-Public Agents
|
|
|
|
This document tracks the various agents, tools, and systems used in the AIOS-Public project.
|
|
|
|
## Documentation Tools
|
|
|
|
### RCEO-AIOS-Public-Tools-DocMaker
|
|
|
|
**Purpose**: Documentation generation container with multiple document conversion tools.
|
|
|
|
**Container/Stack Name**: RCEO-AIOS-Public-Tools-DocMaker
|
|
|
|
**Technology Stack**:
|
|
- Base: Debian Bookworm slim
|
|
- Bash
|
|
- Python 3
|
|
- Node.js
|
|
- Rust (with Cargo)
|
|
- Pandoc
|
|
- LaTeX (Full)
|
|
- mdBook (installed via Cargo)
|
|
- mdbook-pdf (installed via Cargo)
|
|
- Typst
|
|
- Marp CLI
|
|
- Spell/Grammar checking:
|
|
- Hunspell (with en-US dictionary)
|
|
- Aspell (with en dictionary)
|
|
- Vale (style and grammar linter)
|
|
- Reading time estimation: mdstat
|
|
- Additional text processing tools
|
|
|
|
**Usage**: This container/stack should be used for projects that need to generate finished documentation in various formats (PDF, HTML, presentations, etc.).
|
|
|
|
**Docker Configuration**:
|
|
- Located in the `Docker/` directory
|
|
- Includes Dockerfile and docker-compose.yml
|
|
- Maps the project root directory to `/workspace` inside the container
|
|
- Can be run with `docker-compose up` from the Docker directory
|
|
|
|
**Commands to run**:
|
|
```bash
|
|
# Build and start the container
|
|
cd Docker
|
|
docker-compose up --build
|
|
|
|
# Or to run commands directly
|
|
docker-compose run docmaker [command]
|
|
|
|
# Example usage of documentation tools:
|
|
|
|
# Spell checking with hunspell
|
|
docker-compose run docmaker hunspell -d en_US document.md
|
|
|
|
# Grammar/style checking with Vale
|
|
docker-compose run docmaker vale document.md
|
|
|
|
# Reading time estimation
|
|
docker-compose run docmaker python3 -m mdstat document.md
|
|
|
|
# Check spelling with aspell
|
|
docker-compose run docmaker aspell -c document.md
|
|
``` |