Nim Doc Comments

Community

planetis-m

nim-doc-comments

Document exported Nim modules and APIs with doc comments that `nim doc` actually picks up, including module docs, proc and type docs, field docs, and runnable examples. Use when writing documentation for a Nim library or fixing docs that are missing, attached to the wrong symbol, or rendering incorrectly.

Overview

Publisher	planetis-m
Repository	`skills`
Skill name	`nim-doc-comments`
Stars	66
Forks	7
Bundled files	3
Links	Skill source Repository

Markdown instructions
A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.
Works with any LLM
AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.
3 bundled files
Scripts, templates, and references the model can read while it works. Files are read-only and never executed.
Open source
Published by planetis-m on GitHub. Read the source before you install it.

Installation

Install the Nim Doc Comments AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

Open the app and go to Plugins → Skills.
Choose "Install from GitHub".
Paste the skill folder URL below and confirm.
https://github.com/planetis-m/skills/tree/master/nim-doc-comments
Enable the skill in any chat where you want it available.

Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills

git clone --depth 1 https://github.com/planetis-m/skills.git /tmp/skills
mkdir -p .claude/skills
cp -r /tmp/skills/nim-doc-comments .claude/skills/nim-doc-comments

Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Nim Doc Comments in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Nim Doc Comments on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Nim Doc Comments is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

Loaded only when it is needed
The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.
Switch models mid-chat
Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

Nim Doc Comments

Rules

Placement

## is a doc comment — nim doc picks it up. # is a regular comment and is ignored by docs.
Module docs go at the top of the file, before imports.
Proc/func/iterator/template/converter docs go immediately after the signature line, before the body.
Inside type, const, and let blocks, attach docs to the declaration line with trailing ##.
Multi-line docs continue with ## on the following lines, aligned under the declaration.
Enum value and object field docs go on their declaration lines.
Do not put a standalone ## line above a declaration inside a type or const block and expect it to attach.

Visibility

Use ## doc comments for exported symbols and # comments for private implementation details. Non-exported symbols do not appear in rendered docs.

runnableExamples

Do not add runnableExamples: by default.
If used, place runnableExamples: after doc text and before implementation statements.
nim doc compiles and runs all runnableExamples: blocks.

Content

Start with a short summary sentence. Explain behavior, contracts, and constraints.
Skip comments that only restate the symbol name or obvious type info.

Workflow

Identify the exported API.
Place each doc comment using the correct source layout.
Run nim doc path/to/module.nim.
Check source placement and rendered output.
Fix the source comments. Never edit generated output.

Common Mistakes

Mistake	Why it's wrong
Putting a proc doc comment above the proc signature	`nim doc` treats it as module documentation, not proc documentation.
Putting a standalone `##` line above a declaration inside a `type` or `const` block	It does not attach to that symbol; put the doc on the declaration line.
Checking only rendered HTML	A misplaced module-style comment can still render, so source placement still needs inspection.

References

references/module_docs.md — Line and block forms for module docs and top-level examples.
references/proc_and_type_docs.md — Doc placement for exported declarations and fields.
references/runnable_examples.md — runnableExamples forms with placement and compiler flags.

Bundled files

The model reads these on demand while the skill is loaded. They are exposed as readable files and are never executed.

Frequently asked questions

What does the Nim Doc Comments AI skill do?

Why use Nim Doc Comments on TypingMind?

Because you install it once and use it with any model. Nim Doc Comments is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Nim Doc Comments in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/planetis-m/skills/tree/master/nim-doc-comments. TypingMind reads its SKILL.md and bundles its files and installs it as a skill you can enable per chat.

Which AI models can use Nim Doc Comments?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Nim Doc Comments?

As many as you like. As long as a model supports skills, you can use Nim Doc Comments with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Nim Doc Comments AI skill free?

It is published on GitHub by planetis-m. Check the repository for licensing terms. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Discrawl

openclaw

OrganizationPopular

Discord archive: search, sync freshness, DMs, summaries, TUI, repo/release work.

Gitcrawl

GitHub archive: issue/PR search, sync freshness, duplicate clusters, current GitHub handoff, and Gitcrawl repo work.

Graincrawl

Granola archive: search, sync freshness, notes, transcripts, panels, SQL counts, and Graincrawl repo work.

Openclaw Changelog Update

openclaw

OrganizationPopular

Regenerate OpenClaw release changelog sections from git history before beta, stable, or extended-stable releases.

Overview

Installation

Install in TypingMind

Install in another agent

Use it in TypingMind

Works with any AI model

Skill instructions

Nim Doc Comments

Rules

Placement

Visibility

runnableExamples

Content

Workflow

Common Mistakes

References

Bundled files

Frequently asked questions

Related AI Skills

Set up your own AI workspace now