📝 docs: modify the template README.md

Author: bassemkaroui

template/README.md.jinja

@@ -1,76 +1,9 @@
 # {{ project_name }}
 
+{% if repository_provider == 'github' -%}
 [![Release](https://img.shields.io/github/v/release/{{ author_github_handle }}/{{ project_name }})](https://img.shields.io/github/v/release/{{ author_github_handle }}/{{ project_name }})
 [![Build status](https://img.shields.io/github/actions/workflow/status/{{ author_github_handle }}/{{ project_name }}/main.yml?branch=main)](https://github.com/{{ author_github_handle }}/{{ project_name }}/actions/workflows/main.yml?query=branch%3Amain)
 [![codecov](https://codecov.io/gh/{{ author_github_handle }}/{{ project_name }}/branch/main/graph/badge.svg)](https://codecov.io/gh/{{ author_github_handle }}/{{ project_name }})
 [![Commit activity](https://img.shields.io/github/commit-activity/m/{{ author_github_handle }}/{{ project_name }})](https://img.shields.io/github/commit-activity/m/{{ author_github_handle }}/{{ project_name }})
 [![License](https://img.shields.io/github/license/{{ author_github_handle }}/{{ project_name }})](https://img.shields.io/github/license/{{ author_github_handle }}/{{ project_name }})
-
-{{ project_description }}
-
-- **Github repository**: <https://github.com/{{ author_github_handle }}/{{ project_name }}/>
-- **Documentation** <https://{{ author_github_handle }}.github.io/{{ project_name }}/>
-
-## Getting started with your project
-
-### 1. Create a New Repository
-
-First, create a repository on GitHub with the same name as this project, and then run the following commands:
-
-```bash
-git init -b main
-git add .
-git commit -m "init commit"
-git remote add origin git@github.com:{{ author_github_handle }}/{{ project_name }}.git
-git push -u origin main
-```
-
-### 2. Set Up Your Development Environment
-
-Then, install the environment and the pre-commit hooks with
-
-```bash
-make install
-```
-
-This will also generate your `uv.lock` file
-
-### 3. Run the pre-commit hooks
-
-Initially, the CI/CD pipeline might be failing due to formatting issues. To resolve those run:
-
-```bash
-uv run pre-commit run -a
-```
-
-### 4. Commit the changes
-
-Lastly, commit the changes made by the two steps above to your repository.
-
-```bash
-git add .
-git commit -m 'Fix formatting issues'
-git push origin main
-```
-
-You are now ready to start development on your project!
-The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.
-
-To finalize the set-up for publishing to PyPI, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/publishing/#set-up-for-pypi).
-For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/mkdocs/#enabling-the-documentation-on-github).
-To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/codecov/).
-
-## Releasing a new version
-
-{%- if publish_to_pypi %}
-- Create an API Token on [PyPI](https://pypi.org/).
-- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/{{ author_github_handle }}/{{ project_name }}/settings/secrets/actions/new).
-- Create a [new release](https://github.com/{{ author_github_handle }}/{{ project_name }}/releases/new) on Github.
-- Create a new tag in the form `*.*.*`.
-
-For more details, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/cicd/#how-to-trigger-a-release).
 {%- endif %}
-
----
-
-Repository initiated with [fpgmaas/cookiecutter-uv](https://github.com/fpgmaas/cookiecutter-uv).

template/mkdocs.yml.jinja

@@ -6,7 +6,9 @@ repo_name: {{ author_github_handle }}/{{ project_name }}
 {%- endif %}
 site_description: {{ project_description }}
 site_author: {{ author_fullname }}
+{%- if repository_provider == 'github' %}
 edit_uri: edit/main/docs/
+{%- endif %}
 # copyright: Maintained by <a href="https://{{ author_github_handle }}.com">{{ author_github_handle }}</a>.
 copyright: Maintained by <a href="https://github.com/{{ author_github_handle }}">{{ author }}</a>.