Lines breaks
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
Read the linked docs/source/markup/sundries.md line-breaks section first, then compare its documented backslash behavior with the pasted wrapped-text example and the attached output. Done means the intended handling of source line breaks is confirmed and the style-guide guidance clearly explains whether source wrapping appears in rendered output.
Written by the indexing model from the issue text.
Description
The line breaks work differently than I expected. Per https://github.com/elastic/docs-builder-example/blob/main/docs/source/markup/sundries.md#line-breaks "You can break a paraghraph
using \ at the end of a line."
However when I cut and paste content from the elasticsearch repo, where it seems it was assumed that you had to have a defined line length and content wraps despite that, those EOL were appearing as-is in my output. For example:
The latest stable version of {{es}} can be found on the
[Download {{es}}](https://www.elastic.co/downloads/elasticsearch) page. Other
versions can be found on the [Past Releases page](https://www.elastic.co/downloads/past-releases).
If this is working as designed I think we need to be very clear in the style guide info that what you see in your source file is exactly what appears in the output where line breaks are concerned.
- Dominant language
- No language data
- Stars
- 2
- Forks
- 6
- PR merge metrics
- No merged PRs in 30d
Getting set up
We have not checked this project's setup files yet. Start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from elastic/docs-builder-example
-
Difficulty 3/5 1-2 days Newbie friendliness 30/100
elastic/docs-builder-example#5 · 4 comments ·
All issues in elastic/docs-builder-example
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
obra/superpowers#2422 ·
Maintainers usually reply within 6 days
-
triage
Difficulty 1/5 Under an hour Newbie friendliness 90/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
AdobeDocs/workfront.en#69 ·
-
integration: water_heater
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
home-assistant/home-assistant.io#48527 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
bytedance/trae-agent#532 · 2 comments ·
Maintainers usually reply within 1 day