Skip to content

Commit 6e5a1a0

Browse files
committed
docs: add issues numbers to roadmap
1 parent 2376380 commit 6e5a1a0

File tree

2 files changed

+34
-32
lines changed

2 files changed

+34
-32
lines changed

docs/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Home
55
# Welcome to the TagStudio Documentation!
66

77
!!! warning
8-
This documentation is still a work in progress, and is intended to aide with deconstructing and understanding of the core mechanics of TagStudio and how it operates.
8+
This documentation is still a work in progress, and is intended to aide with deconstructing and understanding of the core mechanics of TagStudio and how it operates.
99

1010
![TagStudio Alpha](assets/github_header.png)
1111

@@ -31,6 +31,10 @@ TagStudio is a photo & file organization application with an underlying system t
3131
3. **The application.** If nothing else, TagStudio the application serves as the first (and so far only) implementation for this system of metadata management. This has the responsibility of doing the idea justice and showing just what’s possible when it comes to user file management.
3232
4. (The name.) I think it’s fine for an app or client, but it doesn’t really make sense for a system or standard. I suppose this will evolve with time.
3333

34+
## Feature Roadmap
35+
36+
The [feature roadmap](updates/roadmap.md) lists all of the planned core features for TagStudio to be considered "feature complete" along with estimated release milestones. The development and testing of these features takes priority over all other requested or submitted features unless they are later added to this roadmap. This helps ensure that TagStudio eventually sees a full release and becomes more usable by more people more quickly.
37+
3438
## Current Features
3539

3640
- Create libraries/vaults centered around a system directory. Libraries contain a series of entries: the representations of your files combined with metadata fields. Each entry represents a file in your library’s directory, and is linked to its location.
@@ -42,10 +46,6 @@ TagStudio is a photo & file organization application with an underlying system t
4246
- Search for entries based on tags, ~~metadata~~ (TBA), or filenames/filetypes (using `filename: <query>`)
4347
- Special search conditions for entries that are: `untagged`/`no tags` and `empty`/`no fields`.
4448

45-
## Feature Roadmap
46-
47-
The [feature roadmap](updates/roadmap.md) lists all of the planned core features for TagStudio to be considered "feature complete" along with estimated release milestones. The development and testing of these features takes priority over all other requested or submitted features unless they are later added to this roadmap. This helps ensure that TagStudio eventually sees a full release and becomes more usable by more people more quickly.
48-
4949
## Important Updates
5050

5151
### [Database Migration](updates/db_migration.md)

docs/updates/roadmap.md

Lines changed: 29 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# TagStudio Roadmap
1+
# Roadmap
22

33
This checklist details the current and remaining features required at a minimum for TagStudio to be considered “Feature Complete”. This list is _not_ a definitive list for additional feature requests and PRs as they come in, but rather an outline of my personal core feature set intended for TagStudio.
44

55
## Priorities
66

77
Features are broken up into the following priority levels, with nested priorities referencing their relative priority for the overall feature (i.e. A [LOW] priority feature can have a [HIGH] priority element but it otherwise still a [LOW] priority item overall):
88

9-
- HIGH - Core feature
10-
- MEDIUM - Important but not necessary
11-
- LOW - Just nice to have
9+
- [HIGH] - Core feature
10+
- [MEDIUM] - Important but not necessary
11+
- [LOW] - Just nice to have
1212

1313
## Core Feature List
1414

@@ -19,15 +19,15 @@ Features are broken up into the following priority levels, with nested prioritie
1919
- [x] Tag shorthand (specific short alias for displaying) [HIGH]
2020
- [x] Parent/Inheritance subtags [HIGH]
2121
- [ ] Composition/HAS subtags [HIGH]
22-
- [ ] Deleting Tags [HIGH]
23-
- [ ] Merging Tags [HIGH]
24-
- [ ] Tag Icons [HIGH]
22+
- [ ] Deleting Tags [HIGH] [#148](https://github.com/TagStudioDev/TagStudio/issues/148)
23+
- [ ] Merging Tags [HIGH] [#12](https://github.com/TagStudioDev/TagStudio/issues/12)
24+
- [ ] Tag Icons [HIGH] [#195](https://github.com/TagStudioDev/TagStudio/issues/195)
2525
- [ ] Small Icons [HIGH]
2626
- [ ] Large Icons for Profiles [MEDIUM]
2727
- [ ] Built-in Icon Packs (i.e. Boxicons) [HIGH]
2828
- [ ] User Defined Icons [HIGH]
2929
- [ ] Multiple Languages for Tag Strings [MEDIUM]
30-
- [ ] User-defined tag colors [HIGH]
30+
- [ ] User-defined tag colors [HIGH] [#264](https://github.com/TagStudioDev/TagStudio/issues/264)
3131
- [ ] ID based, not string or hex [HIGH]
3232
- [ ] Color name [HIGH]
3333
- [ ] Color value (hex) [HIGH]
@@ -41,7 +41,7 @@ Features are broken up into the following priority levels, with nested prioritie
4141
- [ ] Tag marked as category does not display as a tag itself [HIGH]
4242
- [ ] [Tag Overrides](../library/tag_overrides.md) [MEDIUM]
4343
- [ ] Per-file overrides of subtags [HIGH]
44-
- [ ] Tag Packs [MEDIUM]
44+
- [ ] Tag Packs [MEDIUM] [#3](https://github.com/TagStudioDev/TagStudio/issues/3)
4545
- [ ] Human-readable (i.e. JSON) files containing tag data [HIGH]
4646
- [ ] Importable [HIGH]
4747
- [ ] Exportable [HIGH]
@@ -50,7 +50,7 @@ Features are broken up into the following priority levels, with nested prioritie
5050
- [ ] Human-readable (i.e. JSON) files containing tag data [HIGH]
5151
- [ ] Importable [HIGH]
5252
- [ ] Exportable [HIGH]
53-
- [ ] Exportable Library Data [HIGH]
53+
- [ ] Exportable Library Data [HIGH] [#47](https://github.com/TagStudioDev/TagStudio/issues/47)
5454
- [ ] Standard notation format (i.e. JSON) contacting all library data [HIGH]
5555
- [ ] [Macros](../utilities/macro.md) [HIGH]
5656
- [ ] Sharable Macros [MEDIUM]
@@ -71,7 +71,7 @@ Features are broken up into the following priority levels, with nested prioritie
7171
- [ ] Stored in system user folder/designated folder [HIGH]
7272
- [ ] Library Settings [HIGH]
7373
- [ ] Stored in `.TagStudio` folder [HIGH]
74-
- [ ] Multiple Root Directories per Library [HIGH]
74+
- [ ] Multiple Root Directories per Library [HIGH] [#295](https://github.com/TagStudioDev/TagStudio/issues/295)
7575
- [ ] [Entry groups](../library/entry_groups.md) [HIGH]
7676
- [ ] Groups for files/entries where the same entry can be in multiple groups [HIGH]
7777
- [ ] Ability to number entries within group [HIGH]
@@ -82,29 +82,30 @@ Features are broken up into the following priority levels, with nested prioritie
8282
- [ ] Fields [HIGH]
8383
- [x] Text Boxes [HIGH]
8484
- [x] Text Lines [HIGH]
85-
- [ ] Dates [HIGH]
85+
- [ ] Dates [HIGH] [#213](https://github.com/TagStudioDev/TagStudio/issues/213)
8686
- [ ] GPS Location [LOW]
87-
- [ ] Custom field names [HIGH]
88-
- [ ] Search engine [HIGH]
89-
- [ ] Boolean operators [HIGH]
90-
- [ ] Tag objects + autocomplete [HIGH]
87+
- [ ] Custom field names [HIGH] [#18](https://github.com/TagStudioDev/TagStudio/issues/18)
88+
- [ ] Search engine [HIGH] [#325](https://github.com/TagStudioDev/TagStudio/issues/325)
89+
- [ ] Boolean operators [HIGH] [#225](https://github.com/TagStudioDev/TagStudio/issues/225), [#314](https://github.com/TagStudioDev/TagStudio/issues/314)
90+
- [ ] Tag objects + autocomplete [HIGH] [#476 (Autocomplete)](https://github.com/TagStudioDev/TagStudio/issues/476)
9191
- [ ] Filename search [HIGH]
9292
- [ ] Filetype search [HIGH]
93-
- [ ] Field content search [HIGH]
93+
- [ ] Field content search [HIGH] [#272](https://github.com/TagStudioDev/TagStudio/issues/272)
9494
- [ ] HAS operator for composition tags [HIGH]
9595
- [ ] OCR search [LOW]
96-
- [ ] Sortable results [HIGH]
96+
- [ ] Fuzzy Search [LOW] [#400](https://github.com/TagStudioDev/TagStudio/issues/400)
97+
- [ ] Sortable results [HIGH] [#68](https://github.com/TagStudioDev/TagStudio/issues/68)
9798
- [ ] Sort by relevance [HIGH]
9899
- [ ] Sort by date created [HIGH]
99100
- [ ] Sort by date modified [HIGH]
100101
- [ ] Sort by date taken (photos) [MEDIUM]
101102
- [ ] Sort by file size [HIGH]
102103
- [ ] Sort by file dimension (images/video) [LOW]
103-
- [ ] Automatic Entry Relinking [HIGH]
104+
- [ ] Automatic Entry Relinking [HIGH] [#36](https://github.com/TagStudioDev/TagStudio/issues/36)
104105
- [ ] Detect Renames [HIGH]
105106
- [ ] Detect Moves [HIGH]
106107
- [ ] Detect Deletions [HIGH]
107-
- [ ] Image Collages [LOW]
108+
- [ ] Image Collages [LOW] [#91](https://github.com/TagStudioDev/TagStudio/issues/91)
108109
- [ ] UI [HIGH]
109110
- [ ] Tagging Panel [HIGH]
110111
- [ ] Top Tags [HIGH]
@@ -118,6 +119,7 @@ Features are broken up into the following priority levels, with nested prioritie
118119
- [ ] Thumbnails [HIGH]
119120
- [ ] File Duration Label [HIGH]
120121
- [ ] 3D Model Previews [LOW]
122+
- [ ] STL Previews [HIGH] [#351](https://github.com/TagStudioDev/TagStudio/issues/351)
121123
- [ ] File Preview Panel [HIGH]
122124
- [ ] Video Playback [HIGH]
123125
- [x] Play/Pause [HIGH]
@@ -127,7 +129,7 @@ Features are broken up into the following priority levels, with nested prioritie
127129
- [x] Toggle Mute [HIGH]
128130
- [ ] Timeline scrubber [HIGH]
129131
- [ ] Fullscreen [MEDIUM]
130-
- [ ] Audio Playback [HIGH]
132+
- [ ] Audio Playback [HIGH] [#450](https://github.com/TagStudioDev/TagStudio/issues/450)
131133
- [ ] Play/Pause [HIGH]
132134
- [ ] Loop [HIGH]
133135
- [ ] Toggle Autoplay [MEDIUM]
@@ -136,14 +138,14 @@ Features are broken up into the following priority levels, with nested prioritie
136138
- [x] Timeline scrubber [HIGH]
137139
- [ ] Fullscreen [MEDIUM]
138140
- [ ] Optimizations [HIGH]
139-
- [ ] Thumbnail caching [HIGH]
141+
- [ ] Thumbnail caching [HIGH] [#104](https://github.com/TagStudioDev/TagStudio/issues/104)
140142
- [ ] File property indexes [HIGH]
141143

142144
## Version Milestones
143145

144146
These version milestones are rough estimations for when the previous core features will be added. For a more definitive idea for when features are coming, please reference the current GitHub [milestones](https://github.com/TagStudioDev/TagStudio/milestones).
145147

146-
### 9.5
148+
### 9.5 (Alpha)
147149

148150
- [ ] SQL backend [HIGH]
149151
- [ ] Multiple Root Directories per Library [HIGH]
@@ -178,7 +180,7 @@ These version milestones are rough estimations for when the previous core featur
178180
- [ ] Optimizations [HIGH]
179181
- [ ] Thumbnail caching [HIGH]
180182

181-
### 9.6
183+
### 9.6 (Alpha)
182184

183185
- [ ] Tags [HIGH]
184186
- [ ] Composition/HAS subtags [HIGH]
@@ -199,7 +201,7 @@ These version milestones are rough estimations for when the previous core featur
199201
- [ ] Dates [HIGH]
200202
- [ ] Custom field names [HIGH]
201203

202-
### 9.7
204+
### 9.7 (Alpha)
203205

204206
- [ ] Configurable Thumbnails [MEDIUM]
205207
- [ ] Toggle File Extension Label [MEDIUM]
@@ -241,7 +243,7 @@ These version milestones are rough estimations for when the previous core featur
241243
- [ ] Set field content [HIGH]
242244
- [ ] [...]
243245

244-
### 9.9
246+
### 9.9 (Possible Beta)
245247

246248
- [ ] Tag Packs [MEDIUM]
247249
- [ ] Human-readable (i.e. JSON) files containing tag data [HIGH]
@@ -255,7 +257,7 @@ These version milestones are rough estimations for when the previous core featur
255257
- [ ] Exportable Library Data [HIGH]
256258
- [ ] Standard notation format (i.e. JSON) contacting all library data [HIGH]
257259

258-
### 10.0
260+
### 10.0 (Possible Beta/Full Release)
259261

260262
- [ ] All remaining [HIGH] and optional [MEDIUM] features
261263

0 commit comments

Comments
 (0)