tomevault-io docpack_confluence Maintainer Guide
This skill provides guidance for developing and maintaining the docpack_confluence library.
Available Topics
Read the specific document when you need detailed information:
| Topic | Document | When to Read |
|---|---|---|
| Project Overview | 01-About-This-Project | Understanding project vision, pain points solved, and use cases |
| Filter Language | 02-Filter-Language | When working with include/exclude patterns, wildcards (/*, /**), URL-based matching, page selection logic, or gitignore-style filters |
| Data Fetching Strategy | 03-Data-Fetching-Strategy | When working with hierarchy fetching, understanding API depth=5 limitation, Parent Clustering Algorithm, crawler optimization, or caching strategy |
| Testing Strategy and Workflow | 04-Testing-Strategy-and-Workflow | When writing tests, creating/deleting test data, understanding hierarchy_specs format, running manual tests, or validating crawler behavior |
| Export and Pack Module | 05-Export-and-Pack-Module | When working with exporter.py, pack.py, SpaceExportConfig, ExportSpec, XML export, all-in-one file generation, or running test_pack.py |
Quick Reference
- Understand the project: Read "Project Overview" first
- Learn filter syntax: Read "Filter Language" for include/exclude patterns
- Understand hierarchy fetching: Read "Data Fetching Strategy" for Parent Clustering Algorithm
- Write tests: Read "Testing Strategy and Workflow" for test data and workflow
- Export pages to XML: Read "Export and Pack Module" for exporter.py and pack.py
Core Concepts
The Three Pain Points
- Precise Batch Selection: gitignore-style
include/excludepatterns with/*wildcards - Rich Metadata Output: XML-wrapped Markdown with source URLs and hierarchical metadata
- Single-File Packaging: Consolidate all pages into one file for easy AI platform sync
Key Components
Entity: Data model for Confluence nodes with lineage (hierarchy path)crawl_descendants: Parent Clustering Algorithm for fetching complete hierarchiescrawl_descendants_with_cache: Cached version for repeated accessSelector: Pattern matcher for include/exclude filteringfilter_pages: Pure filtering function for cached entitiesselect_pages: Convenience API combining crawl + filterSpaceExportConfig: Configuration for exporting pages from a single spaceExportSpec: High-level API for multi-space export with all-in-one merge
Related Skills
(Add related skills here as needed)
Converted and distributed by TomeVault — claim your Tome and manage your conversions.