From 06e1aa7a3c2278bb37dbf7feca7d02b2d3c02752 Mon Sep 17 00:00:00 2001 From: Justine Akehurst <31110637+jakehurst@users.noreply.github.com> Date: Sun, 17 Nov 2024 21:14:47 -0800 Subject: [PATCH] docs: fix link to the feature roadmap page Refs: #593 --- CONTRIBUTING.md | 6 +++--- README.md | 2 +- docs/index.md | 2 +- docs/updates/roadmap.md | 2 +- mkdocs.yml | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index db6d7fa7d..cdd8e3fbe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,14 +11,14 @@ Thank you so much for showing interest in contributing to TagStudio! Here are a ## Getting Started -- Check the [Planned Features](https://github.com/TagStudioDev/TagStudio/blob/main/docs/updates/planned_features.md) page, [FAQ](/README.md/#faq), as well as the open [Issues](https://github.com/TagStudioDev/TagStudio/issues) and [Pull Requests](https://github.com/TagStudioDev/TagStudio/pulls). -- If you'd like to add a feature that isn't on the roadmap or doesn't have an open issue, **PLEASE create a feature request** issue for it discussing your intentions so any feedback or important information can be given by the team first. +- Check the [Feature Roadmap](https://github.com/TagStudioDev/TagStudio/blob/main/docs/updates/roadmap.md) page, [FAQ](/README.md/#faq), as well as the open [Issues](https://github.com/TagStudioDev/TagStudio/issues) and [Pull Requests](https://github.com/TagStudioDev/TagStudio/pulls). +- If you'd like to add a feature that isn't on the feature roadmap or doesn't have an open issue, **PLEASE create a feature request** issue for it discussing your intentions so any feedback or important information can be given by the team first. - We don't want you wasting time developing a feature or making a change that can't/won't be added for any reason ranging from pre-existing refactors to design philosophy differences. - If you wish to discuss TagStudio further, feel free to join the [Discord server](https://discord.com/invite/hRNnVKhF2G) ### Contribution Checklist -- I've read the [Planned Features](https://github.com/TagStudioDev/TagStudio/blob/main/docs/updates/planned_features.md) page +- I've read the [Feature Roadmap](https://github.com/TagStudioDev/TagStudio/blob/main/docs/updates/roadmap.md) page - I've read the [FAQ](/README.md/#faq), including the "[Features I Likely Won't Add/Pull](/README.md/#features-i-likely-wont-addpull)" section - I've checked the open [Issues](https://github.com/TagStudioDev/TagStudio/issues) and [Pull Requests](https://github.com/TagStudioDev/TagStudio/pulls) - **I've created a new issue for my feature _before_ starting work on it**, or have at least notified others in the relevant existing issue(s) of my intention to work on it diff --git a/README.md b/README.md index 3d26790b5..bb0d5b28e 100644 --- a/README.md +++ b/README.md @@ -190,7 +190,7 @@ As of writing (Alpha v9.3.0) the project is in a useable state, however it lacks ### What Features Are You Planning on Adding? > [!IMPORTANT] -> See the [Roadmap](/docs/updates/roadmap.md) documentation for the latest feature lists. The lists here are currently being migrated over there with individual pages for larger features. +> See the [Feature Roadmap](/docs/updates/roadmap.md) documentation for the latest feature lists. The lists here are currently being migrated over there with individual pages for larger features. Of the several features I have planned for the project, these are broken up into “priority” features and “future” features. Priority features were originally intended for the first public release, however are currently absent from the Alpha v9.x.x builds. diff --git a/docs/index.md b/docs/index.md index 16cefdec1..0337398e7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -33,7 +33,7 @@ TagStudio is a photo & file organization application with an underlying system t ## Feature Roadmap -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. +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. ## Current Features diff --git a/docs/updates/roadmap.md b/docs/updates/roadmap.md index e372c7168..4ba3f4f8e 100644 --- a/docs/updates/roadmap.md +++ b/docs/updates/roadmap.md @@ -1,4 +1,4 @@ -# Roadmap +# Feature Roadmap 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. diff --git a/mkdocs.yml b/mkdocs.yml index f34800d15..b3c3c8ad3 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -47,7 +47,7 @@ extra: # - utilities/macro.md # - Updates: # - updates/changelog.md -# - updates/planned_features.md +# - updates/roadmap.md # - updates/db_migration.md theme: