Skip to content

Add project description field via Thyme BC extension and display on project details page #206

Description

@EdiWeeks

Enhancement

Add a dedicated project description field — a single short sentence describing what the project is — and display it on the project details page under the project name / customer line.

The current page shows just the project title (BC's Description field, e.g. "Cairn Homes – Support & Maintenance") and the customer name. There's no room there for a richer one-sentence summary that would help anyone landing on the page understand the project's purpose.

Why a new custom field

Investigated what BC offers natively:

  • Description — already used as the project title on the card; single line, title-length only.
  • Description 2 — not present on BC's Job/Project Card (it exists on Customer/Item cards but not Project).
  • Comments (Comment Sheet) — multi-row list of dated notes, designed for ongoing observations / change history. Not a description; repurposing it would surface unrelated notes (e.g. "PO confirmed by phone") as the public description, which is confusing.

Conclusion: a dedicated, single-purpose field is the cleanest path.

Scope

This is a coordinated change across two repos:

knowall-ai/thyme-bc-extension

  • Add a new field to the Job/Project table (suggested name: Project Description or Description 2, suggested length 250 chars — open to alternatives).
  • Expose it on the extension's /projects endpoint (suggested JSON name: projectDescription).
  • Add it to the Project Card page (under the existing Description field) so it can be edited in BC.

knowall-ai/thyme (this repo)

  • Extend BCProject type in src/types/index.ts with the new field.
  • Render it on the project details page under the customer name line in ProjectHeader.tsx.
  • Hide gracefully when empty.
  • Include in the PDF export so customer-facing exports show the description.

Acceptance criteria

  • BC extension exposes the new field on /projects.
  • BC extension Project Card page lets users enter the description.
  • Thyme renders the description under the customer name on the project details page when present.
  • Field is hidden (no placeholder) when empty.
  • Description appears in the Export PDF output.
  • Extension version bump documented; Thyme footer note / warning if older extension is in use (similar to the blocked-field warning).

Notes

  • Field name and length are starting suggestions — happy to adjust based on BC naming conventions. "Description 2" matches the BC naming convention used on Customer/Item cards.
  • Once the extension is published with this field, an extensionVersion bump should accompany the Thyme PR so the dependency is traceable.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions