dev

MacHu-GWU's avatarfrom MacHu-GWU

Maintainer guide for atlas_doc_parser development. Use when implementing ADF marks/nodes, understanding codebase architecture, or writing tests.

⭐3stars🔀1forks📁View on GitHub🕐Updated Jan 4, 2026

When & Why to Use This Skill

This Claude skill serves as a comprehensive maintainer guide for the atlas_doc_parser library. It streamlines the development process by providing instant access to architectural documentation, implementation patterns for ADF (Atlassian Document Format) marks and nodes, and standardized testing procedures, ensuring high-quality code maintenance and faster onboarding for developers.

Use Cases

  • Implementing new ADF marks or nodes: Use the guide to follow standardized base class patterns and implementation workflows for consistent document parsing.
  • Architectural Onboarding: Quickly understand the project's design philosophy, base classes, and the relationship between JSON schemas and real-world Confluence data.
  • Testing and Quality Assurance: Reference specific testing protocols to write robust unit tests for new parser features and ensure regression safety.
  • Debugging and Error Handling: Consult the guide to implement graceful handling for unimplemented document types and resolve complex parsing issues.
namedev
descriptionMaintainer guide for atlas_doc_parser development. Use when implementing ADF marks/nodes, understanding codebase architecture, or writing tests.

atlas_doc_parser Maintainer Guide

This skill provides guidance for developing and maintaining the atlas_doc_parser library.

Available Topics

Read the specific document when you need detailed information:

Topic Document When to Read
Overview 01-What-is-atlas-doc-parser Understanding project purpose and design philosophy
Three Sources 02-Cross-Referencing Learning about JSON schema, docs, and real Confluence pages
Base Classes 03-The-Base-Class Understanding Base, BaseMark, BaseNode, and markdown helpers
Implementation 04-Per-Mark-Node-Class Implementing a new mark or node dataclass
Testing 05-How-to-Test Writing tests for marks and nodes
Error Handling 06-Graceful-Handling-of-Unimplemented-Types How unimplemented types are handled gracefully

Quick Reference

  • Implement new mark/node: Read "Implementation" then "Testing"
  • Understand architecture: Read "Overview" then "Base Classes"
  • Debug parsing issues: Read "Three Sources" and "Error Handling"
  • adf-format-json-schema - Query ADF JSON schema definitions
  • adf-json-example - Fetch real ADF JSON from Confluence pages
  • implement-model - Automated implementation workflow