annotate-project

Generate a simply-annotate defun/line-tag map from project source code.

100|9|Updated Feb 6, 2025
One-click install
npx skills add https://github.com/captainflasmr/ollama-buddy --skill annotate-project
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: annotate-project
Source: https://github.com/captainflasmr/ollama-buddy/tree/main/.agents/skills/annotate-project
Command: npx skills add https://github.com/captainflasmr/ollama-buddy --skill annotate-project

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generates a simply-annotate database from a project's source code, tagging major blocks and smaller lines to help developers understand structure and navigate large codebases efficiently.

Core Features & Use Cases

  • Two-tier tagging: defun for major syntactical blocks and line for notable sub-blocks, enabling fast filtering and exploration.
  • Project-local narratives: narrative overview stored in a sibling .org file, keeping prose separate from thread data.
  • Use Case: annotate a Java or Python project to quickly generate navigable annotations for code review, onboarding, or documentation.

Quick Start

Run annotate-project to generate a project-local simply-annotate database from your codebase.

Frequently Asked Questions about annotate-project

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

FAQPage Schema
How do I annotate a codebase to generate navigable tags for Emacs?

To annotate a codebase, this Skill reads source files and extracts major blocks and sub-blocks, generating a defun and line-tag map for Emacs simply-annotate. It merges the extracted line-based positions with an existing database and validates the resulting thread data for integrity.

What is the best way to add LLM-driven documentation tags to a multi-language project?

The best way to add LLM-driven documentation tags is applying two-tier tagging: defun tags for major syntactical blocks and line tags for notable sub-blocks. This workflow supports multi-language codebases by extracting meaningful structural positions to aid code understanding and onboarding.

How does block-tagging work for large codebase onboarding and review?

Block-tagging works by reading a project's source code and recording line-based positions for major blocks and smaller sub-blocks. These LLM-driven tags enable fast filtering and exploration, keeping narrative prose separate in a sibling .org file to support efficient codebase review and onboarding.

Can I use simply-annotate with an existing project database without losing data?

Yes, you can use simply-annotate with an existing project database. The workflow automatically merges newly extracted line-based positions with your existing database, subsequently validating the combined thread data for integrity to ensure no data is lost during the annotation process.

Does this codebase annotation approach support both Java and Python projects?

Yes, this codebase annotation approach supports multi-language projects including Java and Python. It extracts major syntactical blocks and meaningful sub-blocks across different languages to generate a navigable simply-annotate database for code review, onboarding, and documentation.

When should I not use LLM-driven tags for source code documentation?

You should not use LLM-driven tags if your project lacks clearly defined major syntactical blocks or if you need to embed narrative prose directly within source files, as this workflow stores project-local narratives separately in a sibling .org file.