Fixes post release

* Fix status badge in the documentation (#64)

* Minor fixes post release (#65)

* Fix broken links in the README

* Remove placeholder

* Version 0.2.1

Co-authored-by: Luca Moschella <luca.moschella94@gmail.com>

Author: Flegyas

README.md

@@ -51,15 +51,15 @@ Install it with:
 </code></pre>
 </details>
 
-More details in the [documentation](https://grok-ai.github.io/nn-template/getting-started/generation/).
+More details in the [documentation](https://grok-ai.github.io/nn-template/latest/getting-started/generation/).
 
 ## Strengths  
-- **Actually works for [research](https://grok-ai.github.io/nn-template/papers/)**!
+- **Actually works for [research](https://grok-ai.github.io/nn-template/latest/papers/)**!
 - Guided setup to customize project bootstrapping;
 - Fast prototyping of new ideas, no need to build a new code base from scratch;
 - Less boilerplate with no impact on the learning curve (as long as you know the integrated tools);
 - Automatize via GitHub actions: testing, stylish documentation deploy, PyPi upload;
-- Enforce Python [best practices](https://grok-ai.github.io/nn-template/features/bestpractices/);
+- Enforce Python [best practices](https://grok-ai.github.io/nn-template/latest/features/bestpractices/);
 
 ## Integrations
 

cookiecutter.json

@@ -9,5 +9,5 @@
     "repository_url": "https://github.com/{{ cookiecutter.github_user }}/{{ cookiecutter.project_name.strip().lower().replace(' ', '-') }}",
     "conda_env_name": "{{ cookiecutter.project_name.strip().lower().replace(' ', '-') }}",
     "python_version": "3.9",
-    "__version": "0.2.0"
+    "__version": "0.2.1"
 }

docs/features/cicd.md

@@ -10,7 +10,7 @@ The generated project contains two [GiHub Actions](https://github.com/features/a
     between workflow runs.
 
 !!! warning
-    The annotated tags in the git repository to manage releases should follow the [semantic versioning](https://semver.org/l)
+    The annotated tags in the git repository to manage releases should follow the [semantic versioning](https://semver.org/)
     conventions: `<major>.<minor>.<patch>`
 
 

docs/features/docs.md

@@ -27,4 +27,4 @@ In order to create your docs it is enough to:
     ```
 
 3. To preview your documentation it is enough to run `mkdocs serve`. To manually deploy the documentation
-    see [`mike`](https://github.com/jimporter/mike), or see the integrated GitHub Action to [publish the docs on release](/features/cicd/#publish-docs).
+    see [`mike`](https://github.com/jimporter/mike), or see the integrated GitHub Action to [publish the docs on release](/latest/features/cicd/#publish-docs).

docs/getting-started/index.md

@@ -2,8 +2,7 @@
 
 When developing neural models ourselves, we often struggled with:
 
-- **Reproducibility**. We strongly believe in the reproducibility requirement of scientific work. Link a WikiNEuRal e
-  set-ops che usano il template!
+- **Reproducibility**. We strongly believe in the reproducibility requirement of scientific work.
 - **Framework Learning**. Even when you find (or code yourself) the best framework to fit your needs, you still end up
   in messy situations when collaborating since others have to learn to use it;
 - **Avoiding boilerplate**. We were bored to write the same code over and over in

docs/index.md

@@ -7,8 +7,8 @@ hide:
 # NN Template
 
 <p align="center">
-    <a href="https://github.com/grok-ai/nn-template/actions/workflows/test_suite.yml"><img alt="CI" src=https://img.shields.io/github/workflow/status/grok-ai/nn-template/Test%20Suite/main"></a>
-    <a href="https://grok-ai.github.io/nn-template"><img alt="Docs" src=https://img.shields.io/github/workflow/status/grok-ai/nn-template/pages%20build%20and%20deployment/gh-pages?label=docs></a>
+    <a href="https://github.com/grok-ai/nn-template/actions/workflows/test_suite.yml"><img alt="CI" src="https://img.shields.io/github/workflow/status/grok-ai/nn-template/Test%20Suite/main"></a>
+    <a href="https://grok-ai.github.io/nn-template"><img alt="Docs" src="https://img.shields.io/github/workflow/status/grok-ai/nn-template/pages%20build%20and%20deployment/gh-pages?label=docs"></a>
     <a href="https://pypi.org/project/nn-template-core/"><img alt="Release" src="https://img.shields.io/pypi/v/nn-template-core?label=nn-core"></a>
     <a href="https://black.readthedocs.io/en/stable/"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
 </p>

docs/integrations/hydra.md

@@ -23,4 +23,4 @@ You can explore aggregate statistics or compare and analyze each run in the W&B
 
 !!! info
 
-    We recommend to go through at least the [Basic Tutorial](https://hydra.cc/docs/tutorials/basic/your_first_app/simple_cli), and the docs about [Instantiating objects with Hydra](https://hydra.cc/docs/patterns/instantiate_objects/overview).
+    We recommend to go through at least the [Basic Tutorial](https://hydra.cc/docs/tutorials/basic/your_first_app/simple_cli), keep in mind that Hydra builds on top of [OmegaConf](https://omegaconf.readthedocs.io/en/latest/index.html).

docs/integrations/mkdocs.md

@@ -13,4 +13,4 @@ Documentation source files are written in Markdown, and configured with a single
     The template comes with Material for MkDocs already configured,
     to create your documentation you only need to write markdown files and define the `nav`.
 
-    See the [Documentation](/features/docs/) page to get started!
+    See the [Documentation](/latest/features/docs/) page to get started!