Merge pull request #18 from nfdi4cat/doc-updates

Doc updates

Author: HendrikBorgelt

.gitignore

@@ -1,5 +1,5 @@
 # generated part of documentation
-/docs/elements/*.md
+/docs/elements/**/*.md
 # linkml-run-examples output (not useful to have in git in its current form)
 /examples/output/
 

2025-09-17_ref_metadata_model_v1.1_share.xlsx

@@ -1,9 +1,9 @@
-# Contributing to CatCore
+# Contributing to CoreMeta4Cat
 
 :+1: First of all: Thank you for taking the time to contribute!
 
 The following is a set of guidelines for contributing to
-CatCore. These guidelines are not strict rules.
+CoreMeta4Cat. These guidelines are not strict rules.
 Use your best judgment, and feel free to propose changes to this document
 in a pull request.
 
@@ -22,7 +22,7 @@ in a pull request.
 
 ## Code of Conduct
 
-The CatCore team strives to create a
+The CoreMeta4Cat team strives to create a
 welcoming environment for editors, users and other contributors.
 Please carefully read our [Code of Conduct](CODE_OF_CONDUCT.md).
 
@@ -73,7 +73,7 @@ Please submit a [Pull Request][pulls] to submit a new term for consideration.
     - Never work on the main branch, always work on an issue/feature branch
     - Core developers can work on branches off origin rather than forks
     - Always create a PR on a branch to maximize transparency of what you are doing
-    - PRs should be reviewed and merged in a timely fashion by the CatCore technical leads
+    - PRs should be reviewed and merged in a timely fashion by the CoreMeta4Cat technical leads
     - PRs that do not pass GitHub actions should never be merged
     - In the case of git conflicts, the contributor should try and resolve the conflict
     - If a PR fails a GitHub action check, the contributor should try and resolve the issue in a timely fashion
@@ -115,7 +115,7 @@ Core developers should read the material on the [LinkML site](https://linkml.io/
 [about-branches]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches
 [about-issues]: https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues
 [about-pulls]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests
-[issues]: https://github.com/HendrikBorgelt/CatCore/issues/
-[pulls]: https://github.com/HendrikBorgelt/CatCore/pulls/
+[issues]: https://github.com/nfdi4cat/CoreMeta4Cat/issues/
+[pulls]: https://github.com/nfdi4cat/CoreMeta4Cat/pulls/
 
 We recommend also reading [GitHub Pull Requests: 10 Tips to Know](https://blog.mergify.com/github-pull-requests-10-tips-to-know/)

CONTRIBUTING.md

@@ -1,12 +1,34 @@
-<a href="https://github.com/dalito/linkml-project-copier"><img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-teal.json" alt="Copier Badge" style="max-width:100%;"/></a>
 
-# CatCore
+[![Build and test](https://github.com/nfdi4cat/CoreMeta4Cat/actions/workflows/main.yaml/badge.svg)](https://github.com/nfdi4cat/CoreMeta4Cat/actions/workflows/main.yaml)
+[![Copier Badge](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-teal.json)](https://github.com/linkml/linkml-project-copier) 
 
-A metadata reference collection for catalysis related research
+
+# CoreMeta4Cat
+
+CoreMeta4Cat is a community-driven metadata initiative under NFDI4Cat that defines the minimum information required for reporting catalysis research data. Built on the FAIR principles — Findable, Accessible, Interoperable, and Reusable — it provides a shared language for researchers to describe, share, and discover catalysis datasets across institutions and disciplines.
+
+The model draws its terminology from Voc4Cat, NFDI4Cat's controlled vocabulary for catalysis, ensuring standardized semantic representation. Fields are classified as Mandatory, Recommended, or Optional, helping users meet minimum quality thresholds while leaving room for richer annotation.
+
+CoreMeta4Cat is a living standard. Community feedback — submitted via the Submit Term Feedback button on the GitHub pages — continuously shapes the addition, revision, and removal of data fields.
+
+CoreMeta4Cat is currently developed in parallel as an Excel metadata field template as well as a LinkML schema.
+
+### Excel Template
+
+The Excel file can be found in [docs/assets](docs/assets/FF_20250627_Overview_metadata.xlsx)
+
+### LinkML Schema
+
+The LinkML Schema can be found in [src/catcore/schema/](src/catcore/schema), but we recommend to use the documentation if you are not familiar with reading native LinkML Schema, which can be found on our [GitHub pages](https://nfdi4cat.github.io/CoreMeta4Cat/):
+
+  * [Reaction](https://nfdi4cat.github.io/CoreMeta4Cat/reaction/)
+  * [Characterization](https://nfdi4cat.github.io/CoreMeta4Cat/characterization/)
+  * [Synthesis](https://nfdi4cat.github.io/CoreMeta4Cat/synthesis/)
+  * [Simulation](https://nfdi4cat.github.io/CoreMeta4Cat/simulation/)
 
 ## Documentation Website
 
-[https://HendrikBorgelt.github.io/CoreMeta4Cat/](https://HendrikBorgelt.github.io/CoreMeta4Cat/)
+[nfdi4cat.github.io/CoreMeta4Cat/](nfdi4cat.github.io/CoreMeta4Cat/)
 
 ## Repository Structure