Skip to content
TuxLux40 edited this page Jul 11, 2026 · 2 revisions

AGENTS.md

Purpose: Help AI coding agents make clean, minimal edits in this markdown-only wiki.

Repository Type

  • Personal knowledge wiki, not application source code.
  • Content is markdown docs only.
  • No build, test, lint, package manager, or CI pipeline in this repo.

Edit Scope

  • Only create or edit .md files (plus image links when needed).
  • Keep edits focused on user ask. No speculative restructuring.
  • Preserve existing voice and practical, hands-on style.

Directory Intent

  • Troubleshooting_guides/: problem -> diagnosis -> fix guides.
  • repo_docs/: stable reference docs for repo/workflow conventions.
  • misc/: curated lists and miscellaneous references.
  • Home.md: top-level hub and index.

File Naming

  • Prefer PascalCase-with-hyphens.md for new pages.
  • Keep names specific to symptom/topic, not generic titles.

Markdown Conventions

  • One # title per file, then clear ## sections.
  • Use fenced code blocks with language labels (for example bash, json).
  • Explain command intent briefly, not just command text.
  • Keep steps actionable and verifiable.

Troubleshooting Page Pattern

Use this lightweight shape when adding a new fix guide:

  1. Scope / affected systems
  2. Symptoms
  3. Diagnosis checks
  4. Fix steps
  5. Verification
  6. References / related docs

Link, Do Not Duplicate

Prefer linking to existing docs over copying large sections:

Navigation Updates

  • If you add a new guide, add a link from Home.md in relevant section.
  • Keep relative links valid from file location.

Safety

  • Do not invent results from commands not run.
  • Avoid destructive recommendations unless user explicitly asks.
  • Keep hardware/distro specifics explicit when relevant (for example CachyOS, ThinkPad T570, Raspberry Pi).

Clone this wiki locally