add-config

Add configuration settings to Wave Terminal by modifying Go structs and regenerating types.

22.0k|1.1k|Updated Jun 8, 2022
One-click install
npx skills add https://github.com/wavetermdev/waveterm --skill add-config
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: add-config
Source: https://github.com/wavetermdev/waveterm/tree/main/.kilocode/skills/add-config
Command: npx skills add https://github.com/wavetermdev/waveterm --skill add-config

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides a comprehensive guide for developers to add new configuration settings to the Wave Terminal application, ensuring consistency and maintainability.

Core Features & Use Cases

  • Structured Configuration: Guides through adding settings to Go structs, JSON schemas, and default configurations.
  • Documentation Integration: Emphasizes updating user-facing documentation for new settings.
  • Type Generation: Details the process of regenerating TypeScript types and schemas.
  • Use Case: A developer needs to introduce a new feature that requires a user-configurable option. This Skill walks them through the entire process, from code implementation to documentation and type updates.

Quick Start

Follow the step-by-step guide in the documentation to add a new configuration setting.

Frequently Asked Questions about add-config

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

FAQPage Schema
How do I add new configuration settings to Wave Terminal?

To add new configuration settings to Wave Terminal, you modify Go structs, update block metadata, set default values, and regenerate documentation and TypeScript types. This ensures your new user-configurable option is fully integrated across the application.

What are the steps to update block metadata when introducing a new setting?

Updating block metadata involves modifying the relevant Go structs and setting appropriate default values. This process ensures the new configuration setting is correctly recognized and applied within the Wave Terminal application architecture.

Do I need to regenerate TypeScript types after modifying Go configuration structs?

Yes, you must regenerate TypeScript types and schemas after modifying Go configuration structs. This type generation step is essential to ensure the frontend and backend remain synchronized when adding new settings to Wave Terminal.

What are the best practices for naming new settings in Wave Terminal?

Best practices for naming new settings in Wave Terminal involve following established naming conventions and type rules. The guide covers these patterns to ensure consistency and maintainability across both frontend and backend usage.

How does configuration override work for Wave Terminal blocks?

Configuration overrides for Wave Terminal blocks allow developers to set specific values that supersede defaults. The guide details how to implement these block overrides correctly within the Go structs and JSON schemas.

Is updating user-facing documentation required when adding a new feature setting?

Yes, updating user-facing documentation is a required step when adding a new feature setting. The guide emphasizes documentation integration to ensure users understand how to configure the newly introduced options.