Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fixed file naming in examples #673

Merged
merged 3 commits into from
Nov 10, 2024
Merged

docs: fixed file naming in examples #673

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
54c6f4a
fixed file naming
musslick Oct 21, 2024
159c256
added contributor note about file naming
musslick Oct 21, 2024
90ec11f
Merge branch 'main' of https://github.com/AutoResearch/autora into fi…
musslick Nov 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/contribute/modules/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
0 ...es/closed-loop-bandit-task/init_autora.md → ...es/closed-loop-bandit-task/init-autora.md
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/examples/closed-loop-bandit-task/testingzone.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

0 ...examples/closed-loop-basic/init_autora.md → ...examples/closed-loop-basic/init-autora.md
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/examples/closed-loop-basic/testingzone.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
4 changes: 2 additions & 2 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand All @@ -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'
Expand Down
Loading