Welcome to the New Flatfile Docs
Introducing our redesigned documentation with improved structure, clarity, and developer experience
We’ve completely redesigned the Flatfile documentation to make it easier for you to build powerful data import experiences.
We Want Your Feedback
These docs are designed as a living, evolving resource that we’re actively improving based on your real-world experience. Your feedback directly shapes how we prioritize updates, add new content, and refine existing guides.
We’d love to hear:
- What’s working well for you?
- What’s still confusing or hard to find?
- What examples or guides would be most helpful?
- How can we make your development experience smoother?
Share your thoughts:
Join our Slack Community
Connect with other developers and the Flatfile team for real-time discussions. Join the #docs channel for documentation-specific feedback and conversations.
Email the Support Team
Send detailed feedback, suggestions, or bug reports directly to our support team - just make sure to include the page you’re on and any context that might help us understand your issue.
What’s Improved
Clearer Structure
We’ve organized content into a progressive learning path that grows with you:
- Getting Started - Jump right in with AutoBuild or build from scratch
- Core Concepts - Understand the fundamental building blocks
- Plugins - Discover pre-built solutions for common data challenges
- Advanced Guides - Deep-dive into complex scenarios and customizations
- Embedding Flatfile - Simple, focused integration guides for every framework
- Reference - Technical details when you need them
Better Navigation
- Progressive disclosure - Start simple, dive deeper as needed
- Consistent patterns - Same structure across similar pages
- Clear pathways - Obvious next steps from any page
- Reduced cognitive load - Less overwhelming, more actionable
Improved First Experience
We’ve redesigned the documentation to be more welcoming to newcomers while still serving advanced users. Instead of overwhelming you with every option upfront, we now guide you step-by-step through the most common paths first - like reading a book rather than a reference manual.
AI and LLM Integration
Built-in support for AI tools and Large Language Models with optimized formats and quick access features:
- Contextual AI menu - Copy pages as Markdown, open directly in ChatGPT or Claude
- LLM-optimized files -
/llms.txt
for structure overview,/llms-full.txt
for comprehensive context - Markdown versions - Every page available in clean Markdown format for better AI processing
Learn more about LLM integration
The Reasoning Behind the Redesign
Our previous documentation grew organically over time, leading to:
- Scattered information across multiple locations
- Overwhelming choices that paralyzed new developers
- Marketing-heavy language that obscured practical guidance
- Inconsistent terminology and outdated definitions
- Complex configuration examples that made simple tasks seem difficult
The new structure follows these principles:
Single Source of Truth
Core concepts are defined once in the Core Concepts section and referenced consistently throughout. No more conflicting definitions across different pages.
Step-by-Step Progression
Start with the simplest approach that works, then provide clear paths to more advanced configurations when needed. Like reading a book, not a reference manual.
Minimal but Reusable Setup
Emphasize that Flatfile works with minimal configuration, encouraging you to get started quickly and iterate from there.
Clear Decision Points
When there are multiple approaches, we explain the tradeoffs and help you choose the right one for your use case.
What’s Next
This is just the beginning. We’re continuously improving based on your feedback and usage patterns. Some areas we’re actively working on:
- Enhanced search and discovery - Making it easier to find exactly what you need
- More hands-on guides - Step-by-step tutorials for common scenarios
- Improved API reference - Better examples and clearer descriptions
- Video walkthroughs - Visual guides for complex workflows
Ready to dive in? Start with our Getting Started guide or explore Embedding Flatfile if you’re ready to integrate.
Thanks for being part of the Flatfile community! 🚀