docs-update

Update Verona language documentation in Markdown files after compiler feature additions.

6|4|Updated Apr 9, 2025
One-click install
npx skills add https://github.com/sylvanc/verona-bc --skill docs-update-sylvanc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-update
Source: https://github.com/sylvanc/verona-bc/tree/main/.claude/skills/docs-update
Command: npx skills add https://github.com/sylvanc/verona-bc --skill docs-update-sylvanc

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Ensures that the Verona language documentation accurately reflects new features and changes to the compiler, maintaining a reliable resource for users.

Core Features & Use Cases

  • Documentation Updates: Modifies Markdown files in vc/docs/ to incorporate new compiler features, syntax, or built-in types.
  • Cross-reference Management: Updates internal links and tables to maintain document integrity after changes.
  • Use Case: After implementing a new callback type in Verona, use this Skill to add its description to 22-builtin-types.md, update the FFI section if applicable, and ensure the grammar summary reflects any new syntax.

Quick Start

Update the Verona documentation to reflect the addition of a new builtin type called 'callback'.

Frequently Asked Questions about docs-update

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

FAQPage Schema
How do I update Verona language documentation after adding new compiler features?

Updating Verona documentation involves modifying Markdown files in vc/docs/ to add descriptions for new builtin types, syntax, or FFI updates. It manages cross-references and grammar summaries to keep all 27 chapters accurate.

What is the process for managing cross-references in technical documentation updates?

Cross-reference management updates internal links and tables within the vc/docs/ directory to maintain document integrity. It ensures accurate navigation across 27 numbered chapters and README.md after incorporating new compiler features.

Can I use this approach to document new FFI features and builtin types in Verona?

Documenting new FFI features and builtin types in Verona involves updating specific files like 22-builtin-types.md and the FFI section. It ensures the grammar summary reflects new syntax and maintains technical accuracy for compiler passes.

How do I ensure documentation conventions are followed when updating compiler feature docs?

Following documentation conventions requires maintaining the established structure across 27 numbered chapters and README.md in vc/docs/. Updates must ensure accurate cross-references and adhere to conventions for technical accuracy regarding new syntax and compiler passes.

What are the limitations when updating Markdown files for technical writing in a compiler project?

Limitations include the strict requirement to manage cross-references across 27 numbered chapters and README.md. The update process is specifically focused on Verona compiler features, new syntax, builtin types, FFI, and compiler passes.