elixir-europe / elixir-europe/rdmkit

Suggestion to have 'Glossary/Definitions' section in pages.

Open
#1,757 4 comments 0 reactions 0 assignees View on GitHub
idea-for-discussion
Dominant language
Python
Stars
117
Forks
160
Avg merge
1d 12h
Merged PRs (30d)
2

Description

**Description**
A general comment, I think if you have the word-count space, then I'd add a 'Glossary/Definitions' section. There are some very useful terms described throughout the text (e.g. technology or domain specific repositories), and although they are described in the text, it would also be good to have it appear in a glossary to enable a quick check.

Suggestion to have 'Glossary/Definitions' section in pages.

Contributor guide

Open the contributing guide

Research direction

No files or pages are named. Start by reviewing the RDMkit pages and the technology- or domain-specific terms already defined in their text, then check whether a glossary or definitions section exists. Done means agreeing which pages and terms are in scope and adding a consistent, quickly searchable glossary where appropriate.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.