docs: Added contact button

centre-for-humanities-computing · Nov 21, 2023 · 0231180 · 0231180
1 parent b5be332
commit 0231180
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 10 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -2,6 +2,10 @@
 
 Welcome to the Danish Foundation Models (DFM) project, a pioneering initiative in the field of machine learning and natural language processing (NLP) dedicated to the Danish language. Our mission is to develop, maintain, and provide open access to high-quality foundation models tailored for Danish, promoting innovation and inclusivity in language technologies.
 
+!!! abstract "Read the paper"
+
+    You can read more about the argument for Danish Language models in our [publication](https://arxiv.org/abs/2311.07264).
+
 ## Why Danish Foundation Models?
 
 ### Bridging the Digital Language Divide
@@ -17,7 +21,7 @@ Welcome to the Danish Foundation Models (DFM) project, a pioneering initiative i
 3. To maintain a high standard of **documentation** of models such as model cards \[[Mitchell et al., 2019](https://arxiv.org/abs/1810.03993)\] and datasheets \[[Gebru et al., 2021](https://cacm.acm.org/magazines/2021/12/256932-datasheets-for-datasets/abstract)\].
 4. To **open-source** not only the models but also all components required for reproducibility such as pre-processing, training, and validation code.
 
-You can read more about the argument for Danish Language models in our [publication](https://arxiv.org/abs/2311.07264).
+
 
 
 ##  Open-source models on closed-source data
@@ -36,9 +40,10 @@ Furthermore, during data processing and training, the data is stored on UCloud w
 We invite collaboration and contributions from industry professionals, researchers, and the open-source community. Together, we can advance the field of Danish NLP and create a more inclusive digital future. You can reach out to us using the following channels:
 
 
-|                                                                                                                      |                                                                    |
-| -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
-| 🗣 [**DDSC Slack**](https://join.slack.com/t/danskdatascie-o8m9638/shared_invite/zt-1jh2dwmj4-D_mjywfXERvVP75n9O0ykg) | Join the discussion in the "danish-foundation-models-text"-channel |
-| 💬 [**GitHub Discussion**](https://github.com/centre-for-humanities-computing/danish-foundation-models/discussions)   | Ask questions or start a discussion                                |
-| 🚨 [**GitHub Issues**](https://github.com/centre-for-humanities-computing/danish-foundation-models/issues)            | Noticed a bug in the code? Please create an issue                  |
+|                                                                                                                                                   |                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
+| :octicons-people-24: - [**DDSC Slack**](https://join.slack.com/t/danskdatascie-o8m9638/shared_invite/zt-1jh2dwmj4-D_mjywfXERvVP75n9O0ykg)           | Join the discussion in the "danish-foundation-models-text"-channel |
+| :octicons-comment-discussion-24: -  [**GitHub Discussion**](https://github.com/centre-for-humanities-computing/danish-foundation-models/discussions) | Ask questions or start a discussion                                |
+| :octicons-issue-tracks-24: - [**GitHub Issues**](https://github.com/centre-for-humanities-computing/danish-foundation-models/issues)                | Noticed a bug in the code? Please create an issue                  |
 
+[Contact us :fontawesome-solid-paper-plane:](mailto:[email protected]){ .md-button }
diff --git a/makefile b/makefile
@@ -1,5 +1,5 @@
 install:
-	pip install -e .[dev,test]
+	pip install -e .[dev,test,docs]
 
 test: ## Run tests
 	pytest src
@@ -20,6 +20,7 @@ pr: ## Run relevant tests before PR
 	make validate
 	gh pr create -w
 
-docs:  ## build and serve documentation
-	pip install -e .[docs]
+docs-serve:  ## build and serve documentation
+	# make sure you have installed docs:
+	# pip install -e .[docs]
 	mkdocs serve
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -2,7 +2,7 @@ site_name: Danish Foundation Models
 docs_dir: "docs/"
 repo_url: https://github.com/centre-for-humanities-computing/danish-foundation-models
 watch: [docs/]
-edit_uri: 'blob/main/docs/'
+edit_uri: "blob/main/docs/"
 theme:
   name: material
   favicon: _static/icon.png
@@ -34,6 +34,13 @@ markdown_extensions:
       alternate_style: true
   - toc:
       permalink: true
+  - attr_list
+  - pymdownx.emoji:
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+  - admonition
+  - pymdownx.details
+  - pymdownx.superfences
 
 copyright: Copyright &copy; 2023 Danish Foundation Models Project