stackabletech / stackabletech/documentation

Reduce the amount of text that gets cut off

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

Nobody has claimed this yet.

priority/low
Dominant language
CSS
Stars
13
Forks
14
Avg merge
4d 8h
Merged PRs (30d)
10

Description

Problem

Text in code blocks is not wrapped around the margin and is hard to read. Here is an example from this page

image

Acceptance criteria

  • The amount of horizontal scrolling individual elements to read the docs is reduced to cases where there is no good alternative.

Contributor guide

No contributing guide indexed for this repository

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

Open the linked Stackable documentation page and inspect how its code blocks are rendered, then locate the relevant CSS in the documentation repository. Verify the change by checking that code blocks wrap or otherwise require less horizontal scrolling, while preserving cases where scrolling is necessary.

Written by the indexing model from the issue text.

Assessment

Tech stack
css
Domain
documentation
Issue type
Bug
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.