Skip to content

Text readability #199

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
bodograumann opened this issue Sep 9, 2021 · 3 comments
Open

Text readability #199

bodograumann opened this issue Sep 9, 2021 · 3 comments
Assignees
@js-choi
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@bodograumann
Copy link

I feel that the overuse of bold markup in the proposal texts leads to bad readability.
Can we remove most of it?
@jamiebuilds
Copy link
Member

I think this issue belongs in https://github.com/tc39/ecmarkup

@js-choi
Copy link
Collaborator

js-choi commented Sep 9, 2021 •
edited
Loading

I think they’re referring to the copious use of bolding in the explainer document. That’s my fault; my apologies.

It’s a habit I picked up from Bret Victor in his Scientific Communication as Sequential Art, and it personally makes it easier for me to read dense technical texts, but I understand that it’s a matter of degree, and it might not apply to everyone.

I think it is a reasonable request to reduce—it doesn’t have to be completely removed, just reduced.

But I don’t currently have time to work on going through the entire explainer document and reducing the boldface, sorry. A pull request would be welcome.

tomByrer added a commit to tomByrer/proposal-pipeline-operator that referenced this issue Sep 15, 2021
@tomByrer
half-way reduce bold, addressing tc39#199
160d95c 
I'm removing 70% of the bold markup, with these rules

* a phrase should only be bolded once in the document
  * headers (`##+`) count as bold
  * (link text)[] count as a type of bold
* new terms are made *italic*
* rare use-case for bold: scalability
  * IMHO much of the document should be re-written to be more scannable, using more headers & bullets, but not my call :)
@js-choi js-choi added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Sep 19, 2021
@js-choi
Copy link
Collaborator

js-choi commented Apr 8, 2025

  • I’m taking a look at this again. I’ll try to reconcile DRAFT: reduce bold, addressing #199 #212 and merge it sometime soonish.
  • I’m also wondering if it might be a good idea to split the explainer into several pages. README.md would preserve its current headings, linking to each subtopic’s article, like in Wikipedia’s summary style. We’ll tackle that after this.
  • We also may want to switch from narrative prose to bulleted list outlines for conciseness. The current explainer text is dense.

@js-choi js-choi self-assigned this Apr 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@js-choi js-choi

Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@js-choi @jamiebuilds @bodograumann