Submit Your Story 📝#
Share your FableFlow creation in our story library to inspire other creators.
Stories are currently from the FableFlow author. Contributions from other creators are welcome.
📚 Submission Guidelines#
What We're Looking For#
🌟 High-Quality Stories
- Complete narratives with a clear beginning, middle, and end
- Engaging characters and plots
- Multimedia elements (images, audio, optional video)
- Age-appropriate content for the specified audience
🎓 Educational Value (Optional)
- Stories that teach or inspire learning
- Accurate, researched information
- Clear learning objectives where applicable
- Discussion questions or extension activities
🎨 Technical Requirements
- All output files generated by FableFlow
- Formatting per the book structure
- Multiple formats (PDF, EPUB, HTML, etc.)
Submission Requirements#
📝 Story Materials
- Complete story files (all formats)
- High-resolution cover image
- Author bio and photo (optional)
- Story summary and description
📋 Educational Information
- Target age range
- Learning objectives
- Subject areas covered
- Discussion questions
⚖️ Legal Requirements
- Original content or proper permissions
- Rights to all images, music, and audio
- Agreement to feature in FableFlow library
- Attribution preferences
🚀 Submission Process#
1. Prepare Your Materials#
After running FableFlow, the generated content is in your output directory. Your story folder should contain the files FableFlow generated, similar to this structure:
Story Package Structure:
your_story_name/
├── draft_story.txt # Your original story draft
├── final_story.txt # Final edited version
├── book.md # Markdown book version
├── book.pdf # PDF version
├── book.epub # EPUB version
├── formatted_book.html # HTML version
├── image_0.png # Generated illustrations
├── image_1.png
├── image_N.png
├── narration.m4a # Audio narration (if generated)
├── music.mp3 # Background music (if generated)
├── story_video.mp4 # Video version (if generated)
└── [other FableFlow outputs]
Reference Example:
See the structure in docs/books/curious_cassie/curious_cassie_beach_ride_quests/ for a complete example.
2. Quality Check#
Before submitting, check your story against these standards:
✅ Content Quality
- Engaging, age-appropriate narrative
- Clear educational value
- Accurate information and research
- Positive, inclusive messaging
✅ Technical Quality
- Error-free text and formatting
- High-quality images and audio
- Consistent visual style
- Accessible design
✅ Educational Value
- Clear learning objectives
- Age-appropriate complexity
- Discussion questions provided
- Extension activities suggested
3. Submit Your Story via GitHub Pull Request#
- Fork the Repository
- Go to https://github.com/suneeta-mall/fable-flow
-
Click "Fork" to create your own copy
-
Add Your Story
- Clone your forked repository
- Create a folder in
docs/books/named with your story (lowercase and underscores, e.g.,my_amazing_story) - Copy all FableFlow-generated files into this folder
-
Match the structure in
docs/books/curious_cassie/curious_cassie_beach_ride_quests/ -
Create a Pull Request
- Commit and push to your fork
- Open a pull request to the main repository
- Use the PR template below
Alternative: Share via GitHub Discussions If you're not comfortable with PRs, share your story in GitHub Discussions for feedback first.
📋 Pull Request Template#
Include this in your PR description:
# Story Submission: [Your Story Title]
## Story Information
- **Title**:
- **Author**:
- **Author GitHub**: @your-github-username
- **Target Age**:
- **Reading Time**:
- **Subjects/Themes**:
## Story Summary
[2-3 sentence description of your story]
## Files Included
- [ ] draft_story.txt
- [ ] final_story.txt
- [ ] book.md / book.pdf / book.epub
- [ ] Images (image_0.png, image_1.png, etc.)
- [ ] narration.m4a (optional)
- [ ] music.mp3 (optional)
- [ ] story_video.mp4 (optional)
## Educational Value (if applicable)
- **Learning Objectives**:
- **Key Concepts**:
- **Discussion Topics**:
## Rights & Permissions
- [ ] I own all rights to this content or have permission to share it
- [ ] I agree to share this story under the Elastic License 2.0
- [ ] All content generated by FableFlow or owned/licensed by me
## Additional Notes
[Any additional information about your story or special requirements]
## Checklist
- [ ] Story folder created in `docs/books/`
- [ ] All generated files from FableFlow included
- [ ] Story structure matches the example format
- [ ] Content is age-appropriate and high-quality
🔄 Review Process#
Maintainers review your story. Once your PR is approved, it is merged and published to the website.
Review Focus Areas#
- Content Quality: Narrative coherence, age-appropriateness, overall quality
- Technical Compliance: File structure and format per the examples
- Rights & Licensing: Confirmation of ownership and licensing compliance
- Community Guidelines: Alignment with project standards
Timelines vary with maintainer availability.
🎯 Tips for Success#
Making Your Story Stand Out#
🎭 Compelling Characters
- Create relatable, diverse protagonists
- Give characters clear motivations
- Show character growth
- Include positive role models
📚 Educational Integration
- Weave learning into the plot
- Use accurate, age-appropriate information
- Provide clear takeaways
- Include hands-on application
🎨 Presentation
- Keep visual style consistent
- Test on multiple devices and formats
- Get feedback before submitting
🌍 Inclusive Storytelling
- Represent diverse characters and perspectives
- Use inclusive language and imagery
- Consider accessibility needs
Common Pitfalls to Avoid#
❌ Educational Overload
- Don't sacrifice story for information
- Avoid overly complex concepts
- Balance education with entertainment
❌ Technical Issues
- Poor image quality or resolution
- Inconsistent formatting
- Audio sync problems
- Accessibility barriers
❌ Content Problems
- Inappropriate content for the age group
- Inaccurate or misleading information
- Stereotypes or exclusive messaging
- Overly promotional content
📞 Questions & Support#
- Technical Support: GitHub Issues
- Content Guidance: educational standards, age-appropriateness, storytelling, accessibility
- Legal & Rights: copyright, permissions, attribution, licensing, usage rights
Contact#
- Story Submissions & Questions: GitHub Issues or GitHub Discussions
- General Inquiries: Direct contact via GitHub (email support coming soon)