Skip to content

Design Documents

Яyan Priebe edited this page May 11, 2024 · 7 revisions

Upcoming feature planning documents. These will be migrated to other pages as features are released.

Spotlight integration

Global search

This document doesn't represent the current state of global search which can be found on Dashboard.

Required functionality

  • Plain text searches to find all matches for a given term (sample search term: completed today)
  • Custom search language to allow users to inspect connections between specific entities (sample search term: @job.jid=1)
  • A new global widget found on each page which provides the same deep searching capabilities as on the Dashboard
  • Advanced search options, the ability to select specific pieces of data to search.
  • Asynchronous search capability
  • New folder/finder-style UI designed to allow you to see as much information about your searches as possible, and how everything is connected. The reasoning for this is that sometimes you may remember one tiny aspect of a larger item, so the app shows as it knows about a requested item. Possibly useful information includes dates and times each record was altered, etc (more to come).

Rules: Plain text searches

  • Anything longer than 2 characters
  • Searches all supported entities (Job, Task, Record, Note, Project, Company), each one should define the fields that can be searched.

Rules: Custom search language

  • Syntax for custom searches, similar to @entity.columnName=value
  • Syntax parser to convert the custom search syntax into a list of search results

Contextual Information

This is more of an outline for how contextual information will be surfaced to the user than a specific feature.

Search widget

Each entity type will relevant contextual information in the Inspector.

Jobs

  • A list of the days on which child entities were created and updated

Records

  • Other records posted that day