Project Notes

Project Notes allow you to document your projects directly within the workspace home. Using Markdown, you can provide your team with setup instructions, project goals, and technical details, ensuring everyone is aligned and can contribute effectively.

For creating projects, assigning resources, or exporting and importing a project, see Managing projects.

Adding and editing notes

Builders can add or edit notes for any project within a workspace.

  1. Select a project from the project tabs at the top of the workspace home.
  2. Click the Read project notes button (the book icon) or scroll down to the Project notes section.
  3. Click Add project notes (if empty) or Edit notes to open the editor.
  4. Use the Markdown editor to write your notes. You can use the Preview tab to check your formatting before saving.
  5. Click Save notes to share your changes with the team.

Markdown support

The editor supports standard Markdown, including:

  • Headings
  • Lists (ordered and unordered)
  • Links
  • Inline code and code blocks
  • Bold and italic text

Conflict resolution

If multiple builders edit the same project notes simultaneously, Budibase will detect a conflict when you attempt to save. If another user has saved changes since you opened the editor, you will be prompted to:

  1. Compare your draft with the latest saved version.
  2. Load latest to see the new content while keeping your draft available.
  3. Use latest revision to acknowledge the conflict and prepare to overwrite the latest version with your draft.

Export and import

Project notes are part of the project's metadata and are automatically included when you export a project. When the project is imported into a new workspace, the notes will be preserved exactly as they were. See Managing projects for the export and import steps.


Did this page help you?