Adding Records
Learn how to document your progress, decisions, and learnings.
What is a Record?
A record is a single entry in your project timeline. It captures a moment in your building journey - a decision made, progress achieved, lesson learned, or reflection noted.
Records can be as brief as a single title or include detailed content with context and reasoning.
Creating a Record
There are several ways to add a record:
From the Project Page
- Navigate to your project
- Click the "New Record" button
- Fill in the title and optionally add content
- Click "Create Record"
Using Quick Log
Press ⌘K (Mac) or Ctrl+K (Windows/Linux) anywhere in the app to open the Quick Log modal.
See the Quick Log guide for more details.
Using the CLI
Log directly from your terminal without leaving your workflow:
bor "Finished implementing user auth"See the CLI guide for setup and more commands.
Record Fields
Title (Required)
A brief summary of the record. This appears prominently in the timeline and should capture the essence of what you're logging.
Examples:
- "Launched beta version"
- "Decided to use PostgreSQL over MongoDB"
- "Fixed the checkout bug"
Content (Optional)
Additional details, context, or reasoning. Use this to capture the "why" behind decisions or document important details you might forget.
For quick notes, you can skip this and just use a title.
Recorded At (Optional)
The date and time the record happened. Defaults to now, but you can backdate records if you're catching up on documentation.
Visibility
Control whether this record is public or private. Public records appear on your public project page. Private records are only visible to you.
The default is determined by your project's visibility settings.
Editing Records
You can edit any of your records at any time:
- Find the record in your project timeline
- Hover over the record and click "Edit"
- Make your changes in the edit dialog
- Click "Save Changes"
You can update the title, content, timestamp, and visibility of any record.
Deleting Records
To delete a record:
- Find the record in your project timeline
- Hover over the record and click "Delete"
- Confirm the deletion
Warning: Deleted records cannot be recovered. Consider editing instead if you just want to update the content.
Tips for Good Records
- 1.Log often - Small, frequent updates are better than occasional large ones
- 2.Capture the "why" - Future you will thank you for the context
- 3.Use title-only for quick notes - Not everything needs detailed content
- 4.Don't overthink it - Any record is better than no record