biolab/orange3-bioinformatics

Docs: rendering puts About at the top

Open

#217 opened on Nov 12, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (21 forks)auto 404
buggood first issue

Repository metrics

Stars
 (24 stars)
PR merge metrics
 (PR metrics pending)

Description

Describe the bug When viewing documentation directly in Orange, the first thing the user sees is a large About section.

To Reproduce Open documentation of Genes widget, for example.

Expected behavior The first thing the user sees is the actual documentation of the widget.

Screenshots

Contributor guide

Research direction
Investigate the documentation rendering template to find where the About section is placed before the widget documentation. Adjust the order so that the widget documentation appears first.
Tech stack
python
Domain
documentation
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70