Notebook System
HomeRunbook includes a fully integrated notebook for documenting your devices, configurations, and procedures.
The Notebook is available on all plans. Team members have access based on their permissions.
Accessing the Notebook
Multiple entry points to your documentation:
- Main Navigation: Click "Notebook" in the navigation bar
- Device Chips: Click the purple icon on any device
- Inventory List: Click the notebook icon next to any device
- Connection Modals: Access connection-specific documentation
- Client Pages: Click the notebook icon next to any client
Creating & Editing Pages
Click any notebook link. If the page doesn't exist, you'll be prompted to create it.
Editor Formats
- Markdown: Headers, lists, code blocks, and standard syntax
- Visual (WYSIWYG): Rich-text editor with formatting toolbar
- Plain Text: Simple notes without formatting
Smart Linking
Cross-link your documentation with special syntax:
Link to Notebook Pages
[[Network Standards]]Creates a link to the page named "Network Standards". Non-existent pages become create prompts.
Link to Application Items
| Entity | Syntax | Example |
|---|---|---|
| Device | [[Device:ID]] or [[Device:ID|Label]] |
[[Device:42]] links to Device #42 |
| Room | [[Map:ID]] or [[Map:ID|Label]] |
[[Map:5|Living Room]] links to Room #5 |
| Client | [[Client:ID]] |
[[Client:10]] links to Client #10 |
What to Document
- Device configurations: IP settings, port forwarding rules
- Passwords and credentials: WiFi passwords, admin logins
- Procedures: How to restart the network, reset devices
- Contact information: ISP support numbers, warranty contacts
- Troubleshooting steps: Common problems and solutions
- Change logs: What was updated and when
Page Organization
- Slugs: Every page has a unique URL-friendly slug (e.g., "wifi-password")
- Recent Changes: The Notebook Home sidebar shows recently updated pages
- Search: Full-text search across all notebook content
Version History
Track every change to your notebook pages (Professional+ plans):
- History View: Click "History" to see all past revisions
- Comparison: Side-by-side diff between any two versions
- Restore: Revert to a previous version
- Change Notes: Add descriptions when saving edits
- Attribution: See who made each change and when
Device-Linked Documentation
Each device can have its own notebook page:
- Access from the purple icon on device chips
- Automatically associated with that device
- Shows device context when viewing
- Keeps documentation where you need it
Exporting Pages
Export individual pages or your entire notebook in various formats:
Single Page Export
Use the dropdown next to the "Export PDF" button when viewing a page:
- PDF: Formatted document ready for printing or sharing
- Markdown: Raw markdown source file (.md)
- HTML: Standalone HTML file with styling
Export All Pages
Use the "Export All" button in the sidebar to export your entire notebook:
- PDF: All pages combined into a single PDF document
- Word (.docx): Microsoft Word document with all pages
- HTML ZIP: Archive of individual HTML files for each page
- Markdown ZIP: Archive of markdown files for backup or migration
Offline Access
Access your notebook pages even without an internet connection - perfect for service technicians in areas with poor signal:
How It Works
- Automatic caching: All notebook pages are cached locally when you browse them
- Background sync: Pages update automatically when you're online
- Offline indicator: A yellow Offline badge appears in the navbar
- Cached content: View cached pages with an "Offline" badge showing when they were last updated
Offline Features
| View all cached notebook pages | |
| Navigate between cached pages | |
| Browse page tree sidebar | |
| Create or edit pages (requires connection) | |
| Upload attachments (requires connection) |
Tip for field technicians: Open the notebook while you have a connection to ensure all pages are cached before heading to a job site with poor signal.
Best Practices
- Document immediately: Add notes when you make changes
- Use templates: Create standard formats for common pages
- Link liberally: Cross-reference related devices and pages
- Include dates: Note when configurations were set up
- Keep it current: Update pages when things change
- Export regularly: Keep backups of your documentation
- Pre-cache for field work: Browse important pages before going offline