Skip to content

Commit

Permalink
added contributor note about file naming
Browse files Browse the repository at this point in the history
  • Loading branch information
musslick committed Oct 21, 2024
1 parent 54c6f4a commit 159c256
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/contribute/modules/index.md
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 comments on commit 159c256

Please sign in to comment.