update docs (#38)

* update badge
* use mkdocs admonition
* update how to guide

README.md

@@ -1,6 +1,6 @@
 # PyBMKG
 
-[![CI](https://github.com/kiraware/PyBMKG/workflows/ci/badge.svg)](https://github.com/kiraware/PyBMKG/actions/workflows/ci.yml)
+[![Test](https://github.com/kiraware/PyBMKG/workflows/Test/badge.svg)](https://github.com/kiraware/PyBMKG/actions/workflows/test.yml)
 [![CodeQL](https://github.com/kiraware/PyBMKG/workflows/CodeQL/badge.svg)](https://github.com/kiraware/PyBMKG/actions/workflows/codeql.yml)
 [![Docs](https://readthedocs.org/projects/pybmkg/badge/?version=latest)](https://pybmkg.readthedocs.io/en/latest/?badge=latest)
 [![codecov](https://codecov.io/gh/kiraware/PyBMKG/graph/badge.svg?token=MN6AXAHO0P)](https://codecov.io/gh/kiraware/PyBMKG)

docs/how-to-guides.md

@@ -34,11 +34,11 @@ example in the following command:
 git branch fix-docs-typos
 ```
 
-And don't forget to checkout and start making changes
+And don't forget to switch and start making changes
 from there.
 
 ```console
-git checkout fix-docs-typos
+git switch fix-docs-typos
 ```
 
 After that, make sure your terminal's working directory
@@ -59,10 +59,12 @@ poetry install
 ```
 
 And done! You can contribute directly by getting your hands wet.
-If you have installed [poethepoet](https://poethepoet.natn.io/index.html)
-globally, then you can use the command below only with `poe lint`,
-`poe format`, etc instead of `poetry run poe lint`,
-`poetry run poe format`, etc.
+
+!!! tip
+    If you have installed [poethepoet](https://poethepoet.natn.io/index.html)
+    globally, then you can use the command below only with
+    `poe lint`, `poe format`, etc instead of `poetry run poe lint`,
+    `poetry run poe format`, etc.
 
 ### Linting
 

docs/index.md

@@ -1,6 +1,6 @@
 # PyBMKG
 
-[![CI](https://github.com/kiraware/PyBMKG/workflows/ci/badge.svg)](https://github.com/kiraware/PyBMKG/actions/workflows/ci.yml)
+[![Test](https://github.com/kiraware/PyBMKG/workflows/Test/badge.svg)](https://github.com/kiraware/PyBMKG/actions/workflows/test.yml)
 [![CodeQL](https://github.com/kiraware/PyBMKG/workflows/CodeQL/badge.svg)](https://github.com/kiraware/PyBMKG/actions/workflows/codeql.yml)
 [![Docs](https://readthedocs.org/projects/pybmkg/badge/?version=latest)](https://pybmkg.readthedocs.io/en/latest/?badge=latest)
 [![codecov](https://codecov.io/gh/kiraware/PyBMKG/graph/badge.svg?token=MN6AXAHO0P)](https://codecov.io/gh/kiraware/PyBMKG)

mkdocs.yml

@@ -61,6 +61,8 @@ nav:
       - reference/schema.md
 
 markdown_extensions:
+  - admonition
+  - pymdownx.details
   - pymdownx.highlight:
       anchor_linenums: true
   - pymdownx.superfences