OpenSourceBrain / OpenSourceBrain/osb-model-validation

Add documentation for mep / omt elements

Open
#28 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
XSLT
Stars
9
Forks
11
PR merge metrics
No merged PRs in 30d

Description

It could be embedded and extracted from the schemas.

examples of useful info

  • list all allowed values for the "expected" attribute
  • which fields need to be defined for the "xxx" attribute?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the schemas that define the mep and omt elements and checking how documentation could be embedded or extracted from them. Done means documenting the allowed values for the expected attribute and the fields required for the xxx attribute, along with the other useful element information identified during the schema review.

Written by the indexing model from the issue text.

Assessment

Tech stack
xml
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.