From a92460f1e70f1a337b272fe1fec7dfa91646a004 Mon Sep 17 00:00:00 2001 From: sfmig <33267254+sfmig@users.noreply.github.com> Date: Thu, 23 May 2024 15:17:10 +0100 Subject: [PATCH] Rename roadmap.md and target name --- README.md | 2 +- docs/source/community/index.md | 4 ++-- docs/source/community/mission-scope.md | 2 +- docs/source/community/{roadmap.md => roadmaps.md} | 4 ++-- docs/source/index.md | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) rename docs/source/community/{roadmap.md => roadmaps.md} (98%) diff --git a/README.md b/README.md index c6259812..2daf8073 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ Pose estimation tools, such as [DeepLabCut](https://www.mackenziemathislab.org/d movement aims to provide a consistent modular interface to analyse pose tracks, allowing steps such as data cleaning, visualisation and motion quantification. We aim to support a range of pose estimation packages, along with 2D or 3D tracking of single or multiple individuals. -Find out more on our [mission and scope](https://movement.neuroinformatics.dev/community/mission-scope.html) statement and our [roadmap](https://movement.neuroinformatics.dev/community/roadmap.html). +Find out more on our [mission and scope](https://movement.neuroinformatics.dev/community/mission-scope.html) statement and our [roadmap](https://movement.neuroinformatics.dev/community/roadmaps.html). ## Status > [!Warning] diff --git a/docs/source/community/index.md b/docs/source/community/index.md index 44d0832a..403f2ca9 100644 --- a/docs/source/community/index.md +++ b/docs/source/community/index.md @@ -3,7 +3,7 @@ Contributions to movement are absolutely encouraged, whether to fix a bug, develop a new feature, or improve the documentation. To help you get started, we have prepared a statement on the project's [mission and scope](target-mission), -a [roadmap](target-roadmap) outlining our current priorities, and a detailed [contributing guide](target-contributing). +a [roadmap](target-roadmaps) outlining our current priorities, and a detailed [contributing guide](target-contributing). ```{include} ../snippets/get-in-touch.md ``` @@ -13,7 +13,7 @@ a [roadmap](target-roadmap) outlining our current priorities, and a detailed [co :hidden: mission-scope -roadmap +roadmaps contributing related-projects license diff --git a/docs/source/community/mission-scope.md b/docs/source/community/mission-scope.md index 4ce929a4..b514f0cd 100644 --- a/docs/source/community/mission-scope.md +++ b/docs/source/community/mission-scope.md @@ -9,7 +9,7 @@ At its core, movement handles trajectories of *keypoints*, which are specific body parts of an *individual*. An individual's posture or *pose* is represented by a set of keypoint coordinates, given in 2D (x,y) or 3D (x,y,z). The sequential collection of poses over time forms *pose tracks*. In neuroscience, these tracks are typically extracted from video data using software like [DeepLabCut](dlc:) or [SLEAP](sleap:). -With movement, our vision is to present a **consistent interface for pose tracks** and to **analyze them using modular and accessible tools**. We aim to accommodate data from a range of pose estimation packages, in **2D or 3D**, tracking **single or multiple individuals**. The focus will be on providing functionalities for data cleaning, visualisation and motion quantification (see the [Roadmap](target-roadmap) for details). +With movement, our vision is to present a **consistent interface for pose tracks** and to **analyze them using modular and accessible tools**. We aim to accommodate data from a range of pose estimation packages, in **2D or 3D**, tracking **single or multiple individuals**. The focus will be on providing functionalities for data cleaning, visualisation and motion quantification (see the [Roadmap](target-roadmaps) for details). While movement is not designed for behaviour classification or action segmentation, it may extract features useful for these tasks. We are planning to develop separate packages for this purpose, which will be compatible with movement and the existing ecosystem of related tools. diff --git a/docs/source/community/roadmap.md b/docs/source/community/roadmaps.md similarity index 98% rename from docs/source/community/roadmap.md rename to docs/source/community/roadmaps.md index b361629d..69b6000e 100644 --- a/docs/source/community/roadmap.md +++ b/docs/source/community/roadmaps.md @@ -1,5 +1,5 @@ -(target-roadmap)= -# Roadmap +(target-roadmaps)= +# Roadmaps The roadmap outlines **current development priorities** and aims to **guide core developers** and to **encourage community contributions**. It is a living document and will be updated as the project evolves. diff --git a/docs/source/index.md b/docs/source/index.md index a0009431..8f578716 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -37,7 +37,7 @@ Pose estimation tools, such as [DeepLabCut](dlc:) and [SLEAP](sleap:) are now co movement aims to provide a consistent modular interface to analyse pose tracks, allowing steps such as data cleaning, visualisation and motion quantification. We aim to support a range of pose estimation packages, along with 2D or 3D tracking of single or multiple individuals. -Find out more on our [mission and scope](target-mission) statement and our [roadmap](target-roadmap). +Find out more on our [mission and scope](target-mission) statement and our [roadmap](target-roadmaps). ```{include} /snippets/status-warning.md ```