Search or ask...
Ctrl K Support App
User Guides
Documentation
Knowledge Files
On this page
Provide a description for your new page.
Community What to Include in Your Knowledge File
Status Every project has its own unique context, goals, and challenges. A knowledge file Best Practices for Maintaining
Knowledge Files
Product Announcement captures this custom context and serves as a living document that evolves with
your project.
Request Feature
Youtube How to Add Custom Knowledge to Your Project – Step-by-S…
Step-by-S…
Share
Introduction
Welcome
Messaging Limits
FAQ
User Guides
Watch on
Quickstart
Figma to Lovable
Visual Edit
What to Include in Your Knowledge File
Knowledge Files
A comprehensive knowledge file covers all essential aspects of your project. Here’s
Labs
a breakdown of what to include:
Troubleshooting
Project Overview: A brief description of the project, its goals, and objectives.
Deploy
User Personas: Detailed descriptions of your target users and their needs.
Custom domain
Feature Specifications: User stories, acceptance criteria, and detailed
Launched
descriptions of each feature.
Prompt Engineering
Design Assets: Links to design files, color palettes, typography, and other
visual elements.
Prompting 1.1
API Documentation: Detailed API endpoints, request/response examples, and
Prompt Library authentication methods.
Debugging Prompts Database Schema: ER diagrams, table structures, and relationships.
Prompts & Integrations Environment Setup: Instructions for setting up the development environment,
including dependencies and configurations.
Integrations Testing Guidelines: Types of tests, testing frameworks, and coverage
Integrations requirements.
GitHub Integration Deployment Instructions: Steps for deploying the application to different
environments (development, staging, production).
Supabase Integration
Version Control Practices: Define your branching strategy, commit message
Stripe & Payments
conventions, and code review guidelines.
Integration with Resend
Security Practices: Guidelines for secure coding, data protection, and handling
Integration with Clerk sensitive information.
Integration with Make Compliance Requirements: Any legal or regulatory requirements your project
Integration with Replicate must adhere to.
Integrate with 21st.dev
Best Practices for Maintaining Knowledge Files
Tips and Tricks
Start Early: Use tools like Lovable’s experimental chat mode to generate a
Using images in Lovable
knowledge file at the beginning of your project.
Using Videos
Keep It Dynamic: Automate updates to ensure your knowledge file stays in
Chrome Adds-on sync with your codebase and documentation.
Using Custom (Google) Fonts Define Roles Clearly: Assign ownership to different sections to ensure
Using npm packages accountability and avoid outdated information.
Mobile Support
SEO
Was this page helpful? Yes No
Resources
Changelog
Video tutorial Visual Edit Labs
Community
Support Policy
Glossary Powered by Mintlify
