Datasets:
Update contributing.md
Ok so this is the first iteration, it is not perfect but I have tried to make examples more general like you suggested
I have also fixed some stuff in the readme related to the artefacts that were carried from Norwegian repo initialisation
-Mention the source and link it in the short description.
+Mention the source and link it in the short description if relevant.
-After the short description, explain what the dataset contains in a little more detail. This is where you describe the main source material, where it comes from, and what topics or document types it covers.
-
-Example of a good description:
-
-```md
-The dataset contains {short data description} from {data source}. It covers {main document types, topics, period, or collection scope}.
-```
+After the short description, explain what the dataset contains in more detail. This can be considered the extended introduction to the dataset it can for instance describe the main source material, where it comes from, and what topics or document types it covers.
continued below
I would move 3. Keep technical processing details out of the description up to the intro:
- The purpose of the dataset card is to provide a user friendly and non-technical description of the dataset. A good card should help understand what the data is, where it comes from, what it contains, and what limitations it may have.
+ The purpose of the dataset card is to provide a user friendly description of the dataset. A good card should help understand what the data is, where it comes from, what it contains, and what limitations it may have. Avoid using technical language when possible. The main description should explain the data itself, not the implementation or processing. Parsing details, filtering logic, token counting, and reconstruction logic usually belong in `create.py`, unless they are necessary for the user to understand a limitation of the released data.
and then remove the rest of section 3.
for section 4 remove the example, same for section 5, 6, 7. I would instead add maybe a reference at the end or in the beginning that for examples datasets they can look at X or Y (making sure X and Y are both high quality and sufficiently different).
I would remove section 8 (it is kinda included in the non-technical documentation).
Done, incorporated the feedback and I have linked the examples from the Danish dynaword (since there a not enough examples in Swedish yet)
I have picked
Enevældens Nyheder Online
Since I think it is one of the best dataset cards
And Kasper's Hvad vil du helst? because it can be an example of non-academic dataset
let me know it these are appropriate
great!