Medical-Event-Data-Standard / Medical-Event-Data-Standard/medical-event-data-standard.github.io

The tutorial needs a clear overview that helps orient users in what the tutorial will do and where they should start.

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

Nobody has claimed this yet.

Ecosystem Documentation priority:high
Dominant language
Jupyter Notebook
Stars
4
Forks
2
PR merge metrics
No merged PRs in 30d

Description

This should go in the main description on the opening page, or in the first sub-module.

Contributor guide

Open the contributing guide

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

Inspect the tutorial's opening page and first sub-module, since the issue suggests either location. Add a clear overview explaining what the tutorial will do and where users should start; the work is done when a new user can orient themselves from the opening content.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.