Skip to content

[Bug]: link to 'Planned Features' in docs leads to a missing page #593

Closed
@jakehurst

Description

@jakehurst

Checklist

  • I am using an up-to-date version.
  • I have read the documentation.
  • I have searched existing issues.

TagStudio Version

main

Operating System & Version

macOS 14.7.1

Description

On https://github.com/TagStudioDev/TagStudio/blob/main/CONTRIBUTING.md, under 'Getting Started,' there is a link to "Check the Planned Features page" which leads to https://github.com/TagStudioDev/TagStudio/blob/main/docs/updates/planned_features.md.

That page was removed with commit 2376380

Expected Behavior

Expected behavior is that by clicking or visiting the link, it should lead to a page that shows the planned features or the feature roadmap instead of a broken link.

The likely fix is to replace the link to instead point to the 'Roadmap' page, added with commit 04149f6

Additionally, search for all other instances of links to 'planned_features.md' and replace those to instead point to 'roadmap.md'.

The Roadmap page title is 'Roadmap'. Should it be 'Feature Roadmap'? We could then make the links to the Feature Roadmap page consistent throughout the documentation, and encourage new contributors to read that page instead.

Steps to Reproduce

  1. Visit https://github.com/jakehurst/TagStudio/blob/main/CONTRIBUTING.md
  2. Scroll to 'Getting Started' section.
  3. Click link 'Planned Features'.
  4. Page leads to a 404 with this error: "The main branch of TagStudio does not contain the path docs/updates/planned_features.md."

Logs

No response

Metadata

Metadata

Assignees

Labels

Type: BugSomething isn't working as intendedType: DocumentationAdditions/changes to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions