cdisc-org / cdisc-org/DataExchange-DDS

Add examples that can be used by MkDoc

Open
#27 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
0
Forks
1
Avg merge
4m
Merged PRs (30d)
3

Description

MkDoc can embed examples in the LinkML class documentation
https://linkml.io/linkml/generators/docgen.html

Examples can optionally be integrated into the documentation; to enable this, pass in the –example-directory argument. The example directory should contain one file per example, following the naming convention -..

For example, to include examples on the page for Person, include examples

Person-001.yaml, Person-002.yaml, etc.

Currently examples must be in yaml

MkDocs option:
example-directory
Folder in which example files are found. These are used to make inline examples

Contributor guide

Open the contributing guide

Research direction

Start with the linked LinkML generator documentation and the MkDocs `example-directory` option. Identify the repository’s documentation or example entry points, then add examples using the `-.` naming convention; done means YAML examples are discovered and rendered inline in the class documentation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.