Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

restructure of doc package

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

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
20/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Review the current doc package layout and locate example.py, example.odml, the XML schema, and the stylesheet for each odML version. Clarify and document where these artifacts should live; the issue does not yet define an agreed structure or a concrete completion condition.

Written by the indexing model from the issue text.

Description

We should discuss the structure of the doc package: Where to put the example.py and example.odml as well as the xml scheme and stylesheet that correspond to the different odml versions.

Dominant language
Python
Stars
25
Forks
30
PR merge metrics
No merged PRs in 30d

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.

More from G-Node/python-odml

All issues in G-Node/python-odml

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.