skills.rest
gesslar
gesslarCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

help-file-creation

Create and organize Oxidus help files under doc/ directories.

8|3|Updated Sep 29, 2021
Search Tags:#documentation#plain-text#autodoc#mudlib#help-files#doc-structure#query_help
One-click install
npx skills add https://github.com/gesslar/oxidus-mudlib --skill help-file-creation
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: help-file-creation
Source: https://github.com/gesslar/oxidus-mudlib/tree/main/.claude/skills/help-file-creation
Command: npx skills add https://github.com/gesslar/oxidus-mudlib --skill help-file-creation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Maintainers need a consistent, discoverable way to create and organize help content for Oxidus, ensuring topics are stored in the correct doc/ locations and are searchable via the built-in help system.

Core Features & Use Cases

  • Static, plain-text help files stored in doc/ subdirectories without extensions, organized by audience directories (general, game, wiz, doc/driver, etc.).
  • Built-in integration with query_help() for command-based help and with the autodoc system for automatic documentation generation.
  • Simple creation workflow: define topics using SKILL.md frontmatter, then write the topic body in a consistent format to ensure predictable behavior in-game help queries.

Quick Start

Create a new file under doc/general/ named after your topic and write content following the documented structure.

Frequently Asked Questions about help-file-creation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create Oxidus help files that are searchable in-game?▼

To create Oxidus help files, write static plain-text topics in doc/ subdirectories without file extensions, organizing them by audience directories like general, game, or wiz to ensure they are discoverable via query_help().

What is the autodoc system for Oxidus mudlib documentation?▼

The autodoc system provides automatic documentation generation for the Oxidus mudlib, integrating with static plain-text help files stored in doc/ directories to standardize in-game help content.

How do I organize plain-text documentation for different audiences in Oxidus?▼

Organize plain-text documentation by placing files into audience-specific doc/ subdirectories such as general, game, wiz, and doc/driver, ensuring users query the correct help scope via the in-game help system.

Do I need SKILL.md frontmatter to integrate help files with query_help()?▼

Yes, SKILL.md frontmatter with name and description is required to define topics, allowing the Oxidus help system to parse and retrieve static plain-text files via query_help().

Can I use optional directories like scripts and references when creating help files?▼

Yes, the help file creation workflow recognizes optional scripts/, references/, and assets/ directories to provide on-demand resources alongside your static plain-text documentation stored in the doc/ tree.

What are the limitations of using static plain-text files for in-game help?▼

Static plain-text help files require manual updates for content changes and rely on consistent formatting within doc/ directories to maintain predictable behavior when queried through query_help().

Related Skills

Explore More Content & Communication Skills→
kdpa-llckdpa-llc
34

skill-creator

Generate SKILL.md files with YAML frontmatter for MCP server skills.

Official
Basic
baekenoughbaekenough
13

omcustom:help

List and query help topics for commands, agents, and rules.

Community
Basic
gesslargesslar
8

skills-and-advancement

Model nested skill trees and progression with Oxidus Mudlib functions.

Community
Advanced
jacardljacardl

nano-pdf

Edit PDF page text and titles using natural-language instructions.

Community
Intermediate