docs: add Getting Started section#133
Open
ChristopherJHart wants to merge 14 commits into
Open
Conversation
…ides Adds a two-page onramp for new users (matching Muninn's documentation pattern): Installation covers requirements and install-from-source steps, Quick Start walks through testbed → job → plan → run. Also adds a "Why Huginn?" section and quick code example to the landing page. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Uses context.broker.execute() instead of device.ssh.send_command(), adds Muninn parsing, TypedDict parameters, per-device result reporting, and add_command_execution() — matching the patterns used in production catalog jobs. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Replaces the hostname example with a show version / IOS-XE version check that mirrors the real verify_ios_version.py catalog job. Also changes the testbed device from an NX-OS spine to an IOS-XE router. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Explains what the job does before showing code, links to Muninn, and notes that alternative parsers (regex, TextFSM, pyATS Genie) work too. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Aligns the quickstart test plan example with the naming convention used in production (VERSION-IOS-VERSION, version-baseline, pre-change phase) rather than numeric IDs. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Shows the report directory structure, the latest symlink, and how to serve the report locally with python -m http.server. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…ucture Move numbered legacy docs (00-glossary.md, 01-overview.md, etc.) into a structured hierarchy: concepts/ for mental-model docs, reference/ for schemas and CLI docs, design/ for architecture and rationale docs. - Update all cross-references (~50 links) to new relative paths - Restructure mkdocs.yml nav into Concepts, Glossary, Authoring, Reference, Design, Contributing sections - Update style guide: single dashes only, no double-dashes or em-dashes - Remove parser-project.md (superseded by Muninn's own documentation) - Update overview: remove stale Quick Example, fix terminology, add early-development note to plugin philosophy section - Delete 05-test-authoring.md (content extracted to context-api.md) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Extract the Context object API, Connection Broker API, result recording, async patterns, and command support checking from the legacy 05-test-authoring.md into a focused reference page. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Explain Huginn's dual execution modes (learning and testing) with a diagram extracted from the BRKXAR-2032 presentation. Covers when to use each mode, how LearningTestCase implements the pattern, parameter storage, and the relationship to scenarios. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Document the four-tier test plan hierarchy (scenarios, phases, test case groups, test cases) with real examples from the BRKXAR-2032 project. Covers file organization, group nesting, and why the structure enables reuse, sequencing, gating, and reconciliation. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Explain the reconciliation workflow as a development-time convenience for building change-validation test plans. Grounds the concept in a concrete example showing pre/post-change phases referencing the same group, and how reconciliation creates phase-specific parameter variants. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Summary
docs/getting-started/installation.md— requirements, install from source (pip + uv), verify, key depsdocs/getting-started/quickstart.md— testbed → test job → test plan → learning run → testing run walkthroughdocs/index.mdwith "Why Huginn?" bullets and a quick code example on the landing pageGetting Startednav section tomkdocs.ymlFollows the same documentation pattern established in Muninn (progressive disclosure: concept → install → use → extend).
Test plan
mkdocs build --strictpasses with no warningsmdformat --checkpasses on all new/modified docsmkdocs serveafter merge🤖 AI Generation Metadata