openml / openml/OpenML

Documentation in two places and inconsistent

Open
#777 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
PHP
Stars
755
Forks
128
PR merge metrics
No merged PRs in 30d

Description

Recently, we had a short discussion where to put new documentation. There is the documentation on the website (https://docs.openml.org/developers/) and documentation in the Wiki (https://github.com/openml/OpenML/wiki)

Keeping this in two places is bound to cause problems in the future, or already does create problems (both forms of documentation are only partly intersecting). I propose that we do either of the following:

  • Move documentation from the wiki to the frontpage
  • Move documentation from the frontpage to the wiki
  • Keep "OpenML usability" documentation on the frontpage, but put developer related issues in the wiki (how to extend openml with new packages, basically all stuff we discuss on the workshops)

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

Start by reviewing the developer documentation at https://docs.openml.org/developers/ and the OpenML Wiki, then inspect the existing discussion about where new documentation belongs. A contribution would need an agreed documentation structure and a completed migration or clearly documented division of content, but this issue does not identify files, tests, or a decided direction.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.