docs: Add MkDocs Material documentation site - #83
Merged
Conversation
- Add mkdocs.yml with Material theme configuration - Create comprehensive documentation pages: - index.md: Project overview and features - getting-started.md: Installation and basic usage - configuration.md: Transcript map and inventory system - transcripts.md: Command outputs and Go templates - cli-reference.md: Complete CLI flag documentation - contributing.md: Development workflow and guidelines - Add GitHub Actions workflow for automatic deployment to gh-pages - Supports dark/light mode, code highlighting, and navigation tabs Closes #53
- Fix all CLI flags to use kebab-case (--starting-port not -startingPort) - Rewrite scenarios section with correct YAML structure - Scenarios are separate from platforms with sequence-based state changes - Update all examples in cli-reference.md, getting-started.md - Add detailed explanation of how scenarios work with example flow
- Add quick reference table to CLI reference - Fix remaining flag format inconsistencies (--flag not -flag) - Correct default branch name from main to master - Add scenario behavior section explaining edge cases - Add default hostname explanation in getting-started - Add comprehensive troubleshooting section to transcripts - Standardize flag references throughout documentation
- Fix all remaining -flag references to use --flag (long form) - Update README.md with current CLI help output - Fix --transcriptMap heading to --transcript-map - Standardize flag references in inventory section - Update Docker examples in README All flags now consistently use kebab-case long form (--starting-port) or documented short form (-p) throughout documentation.
- Add complete inventory usage example with multi-device setup - Add scenario running example showing how to use scenarios - Add end-to-end template usage example with all steps - Add inventory file example to CLI reference - Show how to connect to specific devices by port Each feature now has: 1. Concept explanation 2. Configuration example 3. Usage example 4. Expected output/behavior
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.
Closes #53
Summary
Implements a comprehensive MkDocs Material documentation site hosted on GitHub Pages at
tbotnz.github.io/cisshgo.Changes
Testing
Built and verified locally with
mkdocs build. All pages render correctly.Deployment
Once merged, the workflow will deploy the site to GitHub Pages. Repository settings need to be configured to serve from the
gh-pagesbranch.