From 648ee375b8cb39e402261656a90a5584e69d03bf Mon Sep 17 00:00:00 2001 From: MilagrosMarin Date: Tue, 20 May 2025 01:41:50 +0100 Subject: [PATCH] fix(docs): update home URL from `datajoint.com/docs` to `docs.datajoint.com` --- .github/ISSUE_TEMPLATE/config.yml | 2 +- CONTRIBUTING.md | 2 +- README.md | 2 +- docs/mkdocs.yaml | 2 +- docs/src/.overrides/partials/nav.html | 4 ++-- docs/src/concepts.md | 6 +++--- docs/src/tutorials/index.md | 2 +- 7 files changed, 10 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 287ae12..7436854 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,5 @@ blank_issues_enabled: false contact_links: - name: DataJoint Contribution Guideline - url: https://datajoint.com/docs/about/contribute/ + url: https://docs.datajoint.com/about/contribute/ about: Please make sure to review the DataJoint Contribution Guidelines \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2bd0f49..61a342d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,5 @@ # Contribution Guidelines This project follows the -[DataJoint Contribution Guidelines](https://datajoint.com/docs/about/contribute/). +[DataJoint Contribution Guidelines](https://docs.datajoint.com/about/contribute/). Please reference the link for more full details. diff --git a/README.md b/README.md index e10370b..9c3e7f2 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ tables that can be combined with other Elements to assemble a fully functional p + [Interactive tutorial on GitHub Codespaces](https://github.com/datajoint/element-deeplabcut#interactive-tutorial) -+ [Documentation](https://datajoint.com/docs/elements/element-deeplabcut) ++ [Documentation](https://docs.datajoint.com/elements/element-deeplabcut/) ## Support diff --git a/docs/mkdocs.yaml b/docs/mkdocs.yaml index 7f95640..8c7e7f4 100644 --- a/docs/mkdocs.yaml +++ b/docs/mkdocs.yaml @@ -1,7 +1,7 @@ # ---------------------- PROJECT SPECIFIC --------------------------- site_name: DataJoint Documentation -site_url: http://localhost/docs/elements/element-deeplabcut +site_url: https://docs.datajoint.com/elements/element-deeplabcut/ repo_url: https://github.com/datajoint/element-deeplabcut repo_name: datajoint/element-deeplabcut nav: diff --git a/docs/src/.overrides/partials/nav.html b/docs/src/.overrides/partials/nav.html index fea49d7..faac796 100644 --- a/docs/src/.overrides/partials/nav.html +++ b/docs/src/.overrides/partials/nav.html @@ -14,7 +14,7 @@ {#- Add DataJoint home link to navigation header, otherwise unchanged -#} - + ⬅ Home @@ -30,4 +30,4 @@ {% include "partials/nav-item.html" %} {% endfor %} - + \ No newline at end of file diff --git a/docs/src/concepts.md b/docs/src/concepts.md index 02000bd..936091d 100644 --- a/docs/src/concepts.md +++ b/docs/src/concepts.md @@ -96,7 +96,7 @@ documentation on each table, see the API docs for the respective schemas. | --- | --- | | Device | Camera metadata | -### `subject` schema ([API docs](https://datajoint.com/docs/elements/element-animal/api/element_animal/subject)) +### `subject` schema ([API docs](https://docs.datajoint.com/elements/element-animal/latest/api/element_animal/subject/)) - Although not required, most choose to connect the `Session` table to a `Subject` table. @@ -104,7 +104,7 @@ documentation on each table, see the API docs for the respective schemas. | --- | --- | | Subject | Basic information of the research subject | -### `session` schema ([API docs](https://datajoint.com/docs/elements/element-session/api/element_session/session_with_datetime)) +### `session` schema ([API docs](https://docs.datajoint.com/elements/element-session/latest/api/element_session/session_with_datetime/)) | Table | Description | | --- | --- | @@ -121,7 +121,7 @@ documentation on each table, see the API docs for the respective schemas. | TrainingTask | A set of tasks specifying model training methods. | | ModelTraining | A record of training iterations launched by `TrainingTask`. | -### `model` schema ([API](../api/element_deeplabcut/model)) +### `model` schema ([API docs](../api/element_deeplabcut/model)) - Tables related to DeepLabCut models and pose estimation. The `model` schema can be used without the `train` schema. diff --git a/docs/src/tutorials/index.md b/docs/src/tutorials/index.md index 7ccd7d8..cdc5278 100644 --- a/docs/src/tutorials/index.md +++ b/docs/src/tutorials/index.md @@ -4,7 +4,7 @@ Installation of the Element requires an integrated development environment and database. Instructions to setup each of the components can be found on the -[User Instructions](https://datajoint.com/docs/elements/user-guide) page. These +[User Instructions](https://docs.datajoint.com/elements/user-guide/) page. These instructions use the example [workflow for Element DeepLabCut](https://github.com/datajoint/workflow-deeplabcut), which can be modified for a user's specific experimental requirements. This example