Repository navigation
docs: User Manual, Technician Guide and Site Acceptance Test - #11
Merged
Merged
Conversation
agus-darmawan
added a commit
that referenced
this pull request
Nov 1, 2026
docs: User Manual, Technician Guide and Site Acceptance Test
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What and why
Industrial handover needs documents an operator can follow on a phone during a shift, a technician can tune and maintain from, and a substation representative can sign. Same pipeline as Pashupati (Markdown + YAML front matter → A5 PDF with WeasyPrint, Barlow Semi Condensed, numbered chapters, contents, revision history):
docs/HotDog-User-Manual.pdf) — for operators, no robotics needed:safety in the substation first (the utility's rules and safe approach distances, switching and maintenance, weather, what the robot does not see: holes, drops, objects under ~15 cm), emergency stops; the system at a glance; start of a shift with
hotdog statusexplained line by line; teaching a route and targets per equipment type; patrols, schedule, pause/stop/return, what the watchdog does on its own; reading the reports, severities and what to do, the last round, Telegram alerts (findings are screening results: confirm on site); daily checklist; troubleshooting; quick card./etc/hotdog/site.yaml→ env file), the M20 driver calibration, profile and braking, odometry-only drift and re-anchoring, the Airy merge and the protective field (with its test), speed / stop point / inspection timeouts, the watchdog, the schedule, thermal pod and limits (NETA MTS defaults, regions ininspection.yaml), partial discharge set-up and severities, reports and alerts set-up, addresses and ports, service, time, a maintenance schedule (shift / weekly / monthly / quarterly / yearly), update, backup and restore, symptoms and fixes, and the parameter reference generated from everysrc/*/config/*.yaml.docs/pdf/diagrams.py: system, workflow, a patrol with the watchdog); the system diagram in the README;docs/README.mdindex.docsjob builds the PDFs and warns when a committed PDF is older than its sources; prettier stays off the guide sources (it would unindent the admonitions).hotdog aim <yaw> <pitch> [zoom](point the pod while teaching, tested) andROBOT_PARAMSin the env file (a robot's own profile).How it was tested
pre-commit runon everythingpython3 docs/pdf/build.py: 34 / 46 / 12 sections; pages checked visually (cover, contents, tables, admonitions, code blocks, diagrams)scripts/test5, vermin Python 3.8DHARMA_TOKENChecklist
Generated by Claude Code