doc-standards

Standardize Edgion documentation structure, templates, and multilingual consistency.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/Pandaala/Edgion --skill doc-standards-pandaala
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-standards
Source: https://github.com/Pandaala/Edgion/tree/main/skills/11-doc
Command: npx skills add https://github.com/Pandaala/Edgion --skill doc-standards-pandaala

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you produce consistent, user-friendly Edgion documentation that matches the project’s standards, templates, and multilingual sync rules.

Core Features & Use Cases

  • Doc structure guidance: Enforces the four-layer docs layout and consistent directory/page conventions.
  • Writing and safety standards: Ensures correct tone, headings, complete runnable YAML examples, and safe placeholder usage.
  • Templates and review rigor: Applies required page templates and a comprehensive checklist for accuracy, completeness, and link validity.

Quick Start

Use this skill to validate any docs page you are writing under docs/ against the required templates, YAML completeness rules, i18n symmetry rules, and the documentation review checklist.

Frequently Asked Questions about doc-standards

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

FAQPage Schema
How do I ensure my technical writing meets documentation standards for consistent page templates?

To meet documentation standards, apply required page templates for plugins, routes, ops, and getting started guides. This ensures consistent directory structure, accurate headings, and complete runnable YAML examples across all user-facing technical writing pages.

What is the best way to maintain internationalization symmetry across multilingual documentation?

Maintain internationalization symmetry by enforcing consistent multilingual structure and content rules across translated pages. This i18n sync approach requires matching directory layouts, equivalent page templates, and aligned version-aware callouts for every supported language.

How do I validate technical accuracy and formatting using a doc review checklist?

Validate technical accuracy and formatting by applying a checklist-driven validation process to your documentation. This review verifies safe placeholder usage, complete YAML examples, correct tone formatting, and link safety before publishing any docs page.

Does this documentation standards skill support version-aware callouts for gateway API docs?

Yes, documentation standards support version-aware callouts specifically for gateway API docs. This ensures technical writing remains accurate across different software releases by enforcing mandated YAML example completeness and safe placeholder usage within versioned documentation sections.

Why does my YAML example fail the documentation review checklist validation?

YAML examples fail documentation review checklist validation when they lack complete runnable configurations or use unsafe placeholders. The documentation standards mandate full YAML completeness to ensure users can copy, paste, and execute examples directly without modification.