From cf187db301821562d7d8b4708dc4be06bd2b8a30 Mon Sep 17 00:00:00 2001
From: Twan Goosen <twan@clarin.eu>
Date: Mon, 18 Nov 2024 11:29:40 +0200
Subject: [PATCH 1/2] copied doc content into documentation.md

---
 docs/general-guidelines/documentation.md | 50 ++++++++++++++++++++++++
 1 file changed, 50 insertions(+)

diff --git a/docs/general-guidelines/documentation.md b/docs/general-guidelines/documentation.md
index 25f8d45..e6994a8 100644
--- a/docs/general-guidelines/documentation.md
+++ b/docs/general-guidelines/documentation.md
@@ -1 +1,51 @@
 # Documentation
+
+## General
+
+- In repository: what to include (depending on project type)
+   - Markup format: MD or Asciidoc
+   - Location: root of project
+   - README (what to include… template?) \[Policy\]
+      - Content \[Guidelines\] - [GitHub: Formatting your README](https://guides.github.com/features/wikis/#Formatting-a-readme)
+         - Project name
+         - Description
+         - Table of Contents (optional)
+         - Installation -> INSTALL
+         - Usage
+            - Requirements (runtime, dependencies)
+            - How to build
+            - How to run
+         - Contributing -> CONTRIBUTE
+         - Credits
+         - License -> LICENSE
+   - LICENSE \[Policy\]
+      - See ‘Code license section’
+   - INSTALL (what to include… template?)
+      - Content? \[Guidelines\]
+   - UPGRADE (what to include… template?)
+      - Content? \[Guidelines\]
+   - CHANGES / Release notes
+   - CONTRIBUTING - [GitHub: Setting guidelines for repository contributors](https://docs.github.com/en/github/building-a-strong-community/setting-guidelines-for-repository-contributors)
+      - We will make a general contributions guideline to include by default in all projects
+      - A custom contributions guideline document can be made, describing:
+         - Pull request policy
+         - Issues policy
+         - Branching model
+         - ..
+   - ..
+
+## Design and project documentation
+
+- Requirements & architecture design
+- Roadmap
+
+## End user documentation
+
+- In what cases is it needed?
+- Where
+   - Where/how can the user find it
+   - Where is it maintained (and how is it integrated)
+- In what format
+
+“Stand alone” documentation (in a broad sense, e.g. this handbook) should be
+published under a CC-BY 4.0 licence (“Creative Commons - Attribution 4.0 International”).

From d9e60851ff58a9807fa3cac51d8be43d8a167f80 Mon Sep 17 00:00:00 2001
From: Twan Goosen <twan@clarin.eu>
Date: Mon, 18 Nov 2024 12:33:59 +0200
Subject: [PATCH 2/2] gitignore

---
 .gitignore | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/.gitignore b/.gitignore
index 4befed3..987d3f5 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,4 @@
 .DS_Store
 .idea
+.markdownlint.json
+