Orange-OpenSource / Orange-OpenSource/Orange-Boosted-Bootstrap

Improve examples legibility by adding empty lines between components

Open
#3,283 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

📖 documentation 🧩 enhancement
Dominant language
CSS
Stars
219
Forks
61
Avg merge
2d 15h
Merged PRs (30d)
12

Description

Prerequisites
Proposal

Some example are not legible when there are multiple components (for example: https://ouds-main--boosted.netlify.app/orange/docs/forms/password-input/). I suggest to add an empty after every component code example.

Motivation and context

Some example are not legible when there are multiple components (for example: https://ouds-main--boosted.netlify.app/orange/docs/forms/password-input/).

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 locating the source for the password-input example linked in the issue and inspect how multiple component examples are structured. Check whether the same pattern appears in other examples; done means the component examples are consistently separated by empty lines and remain legible in the rendered documentation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.