diff --git a/docs/contribute/modules/index.md b/docs/contribute/modules/index.md index e7abba512..79656c65b 100644 --- a/docs/contribute/modules/index.md +++ b/docs/contribute/modules/index.md @@ -51,6 +51,10 @@ you will still be able to install your package separately, in addition to `autor It is highly encouraged that you add documentation of your package in `docs/index.md`. You can also add new or delete unnecessary pages in the `docs` folder. However, you structure your documentation, be sure that structure is reflected in the `mkdocs.yml` file. +!!! hint + When naming your documentation files, make sure to use `-` instead of `_` in the file name. For example, + `random-sampler.md` instead of `random_sampler.md`. This style is in alignment with the AutoRA documentation. + You are also encouraged to describe basic usage of your module in the python notebook ``Basic Usage.ipynb`` in the `docs` folder. Finally, you can outline the basic setup of your module in the `docs/quickstart.md` file. diff --git a/docs/examples/closed-loop-bandit-task/init_autora.md b/docs/examples/closed-loop-bandit-task/init-autora.md similarity index 100% rename from docs/examples/closed-loop-bandit-task/init_autora.md rename to docs/examples/closed-loop-bandit-task/init-autora.md diff --git a/docs/examples/closed-loop-bandit-task/testingzone.md b/docs/examples/closed-loop-bandit-task/testingzone.md index a31915b84..120e6ec9d 100644 --- a/docs/examples/closed-loop-bandit-task/testingzone.md +++ b/docs/examples/closed-loop-bandit-task/testingzone.md @@ -120,5 +120,5 @@ This includes a link to your web-based experiment. You can now open this link in ## Next Steps -[Next: Initialize your AutoRA workflow in the researcher hub.](init_autora.md) +[Next: Initialize your AutoRA workflow in the researcher hub.](init-autora.md) diff --git a/docs/examples/closed-loop-basic/init_autora.md b/docs/examples/closed-loop-basic/init-autora.md similarity index 100% rename from docs/examples/closed-loop-basic/init_autora.md rename to docs/examples/closed-loop-basic/init-autora.md diff --git a/docs/examples/closed-loop-basic/testingzone.md b/docs/examples/closed-loop-basic/testingzone.md index 11a41fb6f..380808a76 100644 --- a/docs/examples/closed-loop-basic/testingzone.md +++ b/docs/examples/closed-loop-basic/testingzone.md @@ -109,4 +109,4 @@ This includes a link to your web-based experiment. You can now open this link in ## Next Steps -[Next: Initialize your AutoRA workflow in the researcher hub.](init_autora.md) +[Next: Initialize your AutoRA workflow in the researcher hub.](init-autora.md) diff --git a/mkdocs.yml b/mkdocs.yml index fd14cfc75..36d77ea9a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -185,7 +185,7 @@ nav: - 1 - Set Up Project: 'examples/closed-loop-basic/setup.md' - 2 - Set Up Firebase: 'examples/closed-loop-basic/firebase.md' - 3 - Connect Project With Firebase: 'examples/closed-loop-basic/testingzone.md' - - 4 - Connect Workflow With Firestore: 'examples/closed-loop-basic/init_autora.md' + - 4 - Connect Workflow With Firestore: 'examples/closed-loop-basic/init-autora.md' - 5 - Generating the Experiment: 'examples/closed-loop-basic/experiment.md' - 6 - Create Preprocessing Pipeline: 'examples/closed-loop-basic/preprocessing.md' - 7 - Update the Workflow: 'examples/closed-loop-basic/workflow.md' @@ -195,7 +195,7 @@ nav: - 1 - Set Up Project: 'examples/closed-loop-bandit-task/setup.md' - 2 - Set Up Firebase: 'examples/closed-loop-bandit-task/firebase.md' - 3 - Connect Project With Firebase: 'examples/closed-loop-bandit-task/testingzone.md' - - 4 - Connect Workflow With Firestore: 'examples/closed-loop-bandit-task/init_autora.md' + - 4 - Connect Workflow With Firestore: 'examples/closed-loop-bandit-task/init-autora.md' - 5 - Workflow Explanation: 'examples/closed-loop-bandit-task/workflow.md' - 6 - Testing the Workflow: 'examples/closed-loop-bandit-task/testing.md' - 7 - Connect Project with Prolific: 'examples/closed-loop-bandit-task/prolific.md'