AGENTS.md

This file provides context and instructions for AI coding agents working on the MSPMesh Documentation Wiki project.

Project Overview

MSPMesh.github.io is a Jekyll-based documentation wiki for the MSPMesh community, focused on Minnesota-specific Meshtastic mesh networking information. The site uses the Just The Docs theme and contains tutorials, how-to guides, reference materials, explanations, and tools.

Setup Commands

  • Install Ruby dependencies: bundle install
  • Start development server: bundle exec jekyll serve
  • View site locally: Open http://localhost:4000

Code Style

  • Use standard Markdown formatting
  • Follow Jekyll conventions for front matter
  • Content should be concise and practical, avoiding obvious AI-generated text
  • Focus on Minnesota-specific mesh networking context
  • Use relative links for internal navigation

Content Structure

  • Tutorials: Step-by-step learning for Meshtastic beginners
  • How-to Guides: Problem-solving instructions for experienced users
  • Reference: Lookup tables and technical specifications
  • Explanations: Conceptual background and reasoning
  • Tools: Practical code utilities

Testing Instructions

  • Build the site locally with bundle exec jekyll build
  • Check for broken links and formatting issues
  • Validate that content fits appropriate categories
  • Ensure technical accuracy for Meshtastic/Minnesota context

Dev Environment Tips

  • Use VS Code with Git integration for contributions
  • Test changes locally before submitting PRs
  • Avoid AI-generated content that appears obviously written by AI
  • Focus on high-quality, community-relevant information

PR Instructions

  • Submit all changes as GitHub Pull Requests
  • Include clear descriptions of changes
  • Test locally using Jekyll before submitting
  • Follow contribution standards from root README.md
This site uses Just the Docs, a documentation theme for Jekyll.