insightsengineering / insightsengineering/nestdevs-tasks

[Feature Request]: Improving Readability in Vignette Headings and Indexes

Open
#46 0 comments 0 reactions 0 assignees View on GitHub
core documentation enhancement
Dominant language
No language data
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

### Feature description

In all the vignettes, some headings and indexes feature backticks, which appear somewhat out of place and can make sections challenging to identify due to the smaller font size. I suggest considering alternatives like using italics or a different formatting style, or perhaps keeping it as plain text instead of backticks for code elements in headings.

Here is some screenshots for reference
image

Reading section
image

### Code of Conduct

- [X] I agree to follow this project's Code of Conduct.

### Contribution Guidelines

- [X] I agree to follow this project's Contribution Guidelines.

### Security Policy

- [X] I agree to follow this project's Security Policy.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.