docs: Make docs for dev (#111)

* docs: Remove unused documentation related to app usage

* deps: Update mkdocs dependencies for documentation improvements

* docs: Add new documentation files and update dependencies

* deps: additional packages for docs

* docs: Update logo images and mkdocs.yml

* docs: Update mkdocs configuration and add social links

* chore: Add griffe_typingdoc extension for documentation improvements

* deps: Update mkdocs configuration and add social links

* chore: Update .gitignore to exclude 'site' directory

* chore: Update skip list in pyproject.toml to exclude 'docs/images' directory

.gitignore

@@ -2,6 +2,7 @@ venv
 __pycache__
 dist
 tests/data
+site
 .venv
 .idea
 .ruff_cache

Makefile

@@ -66,10 +66,14 @@ clean:
 	rm -rf docs/_build
 	rm -rf coverage.xml
 
-.PHONY: docs  ## Generate the docs
-docs:
+.PHONY: generate-docs  ## Generate the docs
+generate-docs:
 	pdm run mkdocs build --strict
 
+.PHONY: serve-docs  ## Serve the docs
+serve-docs:
+	pdm run mkdocs serve
+
 .PHONY: help  ## Display this message
 help:
 	@grep -E \

README.md

@@ -23,48 +23,45 @@
 
 ---
 
-__Source Code__: https://github.com/siapy/siapy-lib
+__Source Code__: <https://github.com/siapy/siapy-lib>
 
-__Bug Report / Feature Request__: https://github.com/siapy/siapy-lib/issues/new/choose
+__Bug Report / Feature Request__: <https://github.com/siapy/siapy-lib/issues/new/choose>
 
 <!-- **Tutorials**: <a href="https://github.com/Agricultural-institute/SiaPy/tree/master/tutorials" target="_blank">https://github.com/Agricultural-institute/SiaPy/tree/master/tutorials</a> -->
 
-__Documentation__: https://github.com/siapy/siapy-lib/tree/main/docs
+__Documentation__: <https://github.com/siapy/siapy-lib/tree/main/docs>
 
 ---
 
-**Note:** The library is currently under development!
+__Note:__ The library is currently under development!
 
-## How to get started
+## Installation
 
-First, check out the [setup](docs/setup_guide.md) tutorial which will walk you through installing the necessary tools to run the tutorials.
-After, see how the app is used in [command-line](docs/app_use.md) fashion.
-Next, check the [tutorial](tutorials) articles to learn how to use the application for particular purposes. The set of example notebooks and their outputs can be viewed in your browser without downloading anything or running any code.
+``` bash
+pip install siapy
+```
 
 ## Contribution guidelines
 
-Small improvements or fixes are always appreciated. If you are considering larger contributions to the source code, please contact us through e-mail.
+We always welcome small improvements or fixes. If you’re considering making more significant contributions to the source code, please contact us via email.
 
-Writing code isn’t the only way to contribute to SiaPy. You can also:
+Contributing to SiaPy isn’t limited to coding. You can also:
 
-* help us stay on top of new and old issues
-* develop tutorials, presentations, and other educational materials
-* develop a graphical application
-* implement new features
+* Help us manage and resolve issues, both new and existing.
+* Create tutorials, presentations, and other educational resources.
+* Propose new features.
 
-If you’re unsure where to start or how your skills fit in, reach out! You can ask on the e-mail or here, on GitHub, by opening a new issue or leaving a comment on a relevant issue that is already open.
+Not sure where to start or how your skills might fit in? Don’t hesitate to reach out! You can contact us via email, or connect with us directly on GitHub by opening a new issue or commenting on an existing one.
 
-If you are new to contributing to open source, this [guide](CONTRIBUTING.md) helps explain how to successfully get involved.
+If you’re new to open-source contributions, check out our [guide](CONTRIBUTING.md) for helpful tips on getting started.
 
 ## Issues and new features
 
-Find a problem with the tutorial? Please look through the existing issues (open and closed) and if it's new, create an issue on GitHub.
+Encountered a problem with the library? Please report it by creating an issue on GitHub.
 
-Want to correct an issue or expand library functionality? Fork the repository, make your fix and submit a pull request on GitHub.
+Interested in fixing an issue or enhancing the library’s functionality? Fork the repository, make your changes, and submit a pull request on GitHub.
 
-Want an additional feature, but don't have time to implement it yourself? Kindly ask under issues and someone else may implement it for you.
-
-Have a question? Please double-check that you're able to run the setup successfully, and resolve any issues with that first. If you're pulling newer code, it may be necessary in some cases to delete and re-create your SiaPy environment to make sure you have all of the expected packages.
+Have a question? First, ensure that the setup process was completed successfully and resolve any related issues. If you’ve pulled in newer code, you might need to delete and recreate your SiaPy environment to ensure all the necessary packages are correctly installed.
 
 ## License
 

docs/api/entity.md

@@ -0,0 +1 @@
+::: siapy.entities.shapes

docs/changelog.md

@@ -0,0 +1 @@
+{{ external_markdown('https://raw.githubusercontent.com/siapy/siapy-lib/main/CHANGELOG.md', '') }}

docs/contributing.md

@@ -0,0 +1 @@
+{{ external_markdown('https://raw.githubusercontent.com/siapy/siapy-lib/main/CONTRIBUTING.md', '') }}