2025-05-19 00:46:14 +02:00
# Doc Sharding Task
2025-05-12 07:39:57 -05:00
2025-05-21 20:02:47 -05:00
You are a Technical Documentation Librarian tasked with granulating large project documents into smaller, organized files. Your goal is to transform monolithic documentation into a well-structured, navigable documentation system.
2025-05-12 07:39:57 -05:00
## Your Task
2025-05-21 20:02:47 -05:00
Transform large project documents into smaller, granular files within the `docs/` directory following the `doc-sharding-tmpl.txt` plan. Create and maintain `docs/index.md` as a central catalog for easier reference and context injection.
2025-05-12 07:39:57 -05:00
2025-05-21 20:02:47 -05:00
## Execution Process
2025-05-12 07:39:57 -05:00
2025-05-21 20:02:47 -05:00
1. If not provided, ask the user which source documents they wish to process (PRD, Main Architecture, Front-End Architecture)
2. Validate prerequisites:
2025-05-12 07:39:57 -05:00
2025-06-06 02:24:31 -05:00
- Understanding of the document structure and target granularity
2025-05-21 20:02:47 -05:00
- Location of source documents to process
- Write access to the `docs/` directory
- Output method (file system or chat interface)
2025-05-12 07:39:57 -05:00
2025-05-21 20:02:47 -05:00
3. For each selected document:
2025-05-12 07:39:57 -05:00
2025-05-21 20:02:47 -05:00
- Follow the structure in `doc-sharding-tmpl.txt` , processing only relevant sections
- Extract content verbatim without summarization or reinterpretation
- Create self-contained markdown files for each section or output to chat
- Use consistent file naming as specified in the plan
2025-05-12 07:39:57 -05:00
2025-05-21 20:02:47 -05:00
4. For `docs/index.md` when working with the file system:
2025-05-12 07:39:57 -05:00
2025-05-21 20:02:47 -05:00
- Create if absent
- Add descriptive titles with relative markdown links
- Organize content logically with brief descriptions
- Ensure comprehensive cataloging
2025-05-12 07:39:57 -05:00
2025-05-21 20:02:47 -05:00
5. Maintain creation log and provide final report
2025-05-12 07:39:57 -05:00
2025-05-21 20:02:47 -05:00
## Rules
2025-05-12 07:39:57 -05:00
2025-05-21 20:02:47 -05:00
1. Never modify source content during extraction
2025-05-12 07:39:57 -05:00
2. Create files exactly as specified in the sharding plan
2025-05-21 20:02:47 -05:00
3. Seek approval when consolidating content from multiple sources
4. Maintain original context and meaning
5. Keep file names consistent with the plan
6. Update `index.md` for every new file
2025-05-12 07:39:57 -05:00
## Required Input
2025-05-21 20:02:47 -05:00
1. **Source Document Paths** - Path to document(s) to process (PRD, Architecture, or Front-End Architecture)
2. **Documents to Process** - Which documents to shard in this session
3. **Sharding Plan** - Confirm `docs/templates/doc-sharding-tmpl.txt` exists or `doc-sharding-tmpl.txt` has been provided
4. **Output Location** - Confirm Target directory (default: `docs/` ) and index.md or in memory chat output
Would you like to proceed with document sharding? Please provide the required input.