Skip to content

v4.26.2: Skills Documentation Improvements

Choose a tag to compare

View all tags
@dgunning dgunning released this 07 Nov 00:42
· 1882 commits to main since this release
v4.26.2
9b77c11

Critical Fixes

Issue #480: Critical Documentation Gaps in Skills Package

  • Added missing set_identity() requirement to all documentation entry points
  • Added prominent documentation for to_context() method (5-10x token efficiency)
  • Added Prerequisites & Setup section to SKILL.md with SEC identity requirement
  • Added Token-Efficient API Usage section with comparison tables
  • Added Troubleshooting section with 4 common errors and solutions
  • Impact: Agents no longer experience immediate failures, discover token-efficient methods
  • Root Cause: Critical setup step and efficiency feature were buried in documentation

Changed

Issue #481: Skills Documentation Restructuring for Token Efficiency

  • Restructured SKILL.md from 10,200 → 3,400 tokens (65% reduction)
  • Extracted 13 complete examples to new common-questions.md (366 lines)
  • Extracted advanced patterns to new advanced-guide.md (256 lines)
  • Replaced Common Questions section with Quick Reference table
  • Added programmatic documentation access guide for AI agents
  • Impact: 60% faster documentation loading for agents, improved navigation

Documentation Token Optimization Across Skills Package

  • Optimized objects.md: 803 → 753 lines (~200-250 token reduction)
    • Removed duplicate "Documentation Features" section
    • Fixed obj.text() to obj.to_context() in tables
    • Inlined all bullet lists (Contains, When to Use, Documentation Features)
  • Optimized data-objects.md: 587 → 556 lines (~120-150 token reduction)
    • Inlined all "Key Features" sections
    • Inlined Layer 1/Layer 2 descriptions
    • Inlined Common DataFrame Columns list
  • Optimized SKILL.md: 482 → 460 lines (~150 token reduction)
    • Conservative rephrasing for reduced verbosity
    • Converted bullet lists to inline format
    • Tightened introductory sections
  • Total Impact: ~470-550 token savings across documentation

Enhanced Agent Documentation Navigation

  • Added routing note to readme.md directing agents to SKILL.md
  • Documented skill.get_document_content() API for programmatic access
  • Added navigation guidance to all skill entry points
  • Impact: Agents find correct entry point and can navigate documentation programmatically

Fixed (Documentation)

  • Fixed incorrect skill name in API examples ("SEC Filing Analysis" → "EdgarTools")
  • Fixed inconsistent method references (obj.text() → obj.to_context())
  • Fixed duplicate documentation sections in objects.md
  • Added API reference table to objects.md for Company object attributes

Install

pip install --upgrade edgartools

What's Changed

Full Changelog: v4.26.1...v4.26.2

Closes #480, #481

Assets 2
Loading