nandi.uk
This repository has no description
new feature template doc and initial notes of search feature
author
Wesley Finck
date
(Jul 25, 2025, 2:51 PM -0700)
commit
e6bc38c9
e6bc38c923a78d291f7d60397687eabe744e1221
parent
319834ba
319834bae05973e1aae1198853eaebcd83bde451
+73
+36
docs/features/CollectionTextSearch.md
+36
docs/features/CollectionTextSearch.md
···
1
+
- want to be able to perform text search over a users collections so that they can quickly and easily add a card to existing collections.
2
+
- will this be part of the `GetMyCollectionsUseCase` with added query params (text field) or do we treat it separately as `SearchMyCollectionsUseCase`?
3
+
- we currently have the following API method and types:
4
+
5
+
```typescript
6
+
async getMyCollections(
7
+
params?: GetMyCollectionsParams,
8
+
): Promise<GetMyCollectionsResponse> {
9
+
return this.queryClient.getMyCollections(params);
10
+
}
11
+
12
+
export interface GetMyCollectionsParams {
13
+
page?: number;
14
+
limit?: number;
15
+
sortBy?: string;
16
+
sortOrder?: 'asc' | 'desc';
17
+
}
18
+
19
+
export interface GetCollectionPageResponse {
20
+
id: string;
21
+
name: string;
22
+
description?: string;
23
+
author: {
24
+
id: string;
25
+
name: string;
26
+
handle: string;
27
+
avatarUrl?: string;
28
+
};
29
+
urlCards: CollectionPageUrlCard[];
30
+
pagination: Pagination;
31
+
sorting: Sorting;
32
+
}
33
+
```
34
+
35
+
- will it make more sense to have something like .searchMyCollections(searchString: string)
36
+
- what are my options?
+37
docs/features/NEW_FEATURE_TEMPLATE.md
+37
docs/features/NEW_FEATURE_TEMPLATE.md
···
1
+
## Overview
2
+
3
+
- Brief description of the feature and its purpose.
4
+
5
+
## Goals
6
+
7
+
- List the primary objectives for this feature.
8
+
9
+
## Non-Goals
10
+
11
+
- Clarify what is out of scope.
12
+
13
+
## User Stories / Use Cases
14
+
15
+
- Example scenarios or user flows.
16
+
17
+
## Requirements
18
+
19
+
- Functional requirements
20
+
- Non-functional requirements
21
+
22
+
## Design
23
+
24
+
- High-level architecture or flow diagram (optional)
25
+
- Key components/modules
26
+
27
+
## API / UI Changes
28
+
29
+
- Endpoints, parameters, or UI elements to be added/modified.
30
+
31
+
## Open Questions
32
+
33
+
- List any unresolved issues or decisions.
34
+
35
+
## Milestones
36
+
37
+
- Key steps or phases for implementation.