holochain / holochain/docs-pages

Better syntax highlighting for rust code

Open
#444 5 comments 0 reactions 0 assignees View on GitHub
Dominant language
Nunjucks
Stars
98
Forks
32
Avg merge
9h 49m
Merged PRs (30d)
2

Description

The syntax highlighting we're using in code examples doesn't clearly distinguish many of the syntax elements of rust code. This makes it far less readable.

For example, this is our docs:
![image](https://github.com/holochain/docs-pages/assets/159270/cc067c60-a80e-4d9d-9358-20b51767b14e)

And this is vscode:
![image](https://github.com/holochain/docs-pages/assets/159270/3e066f4e-ce82-4c4b-b1b2-f4693395ee3a)

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the syntax-highlighting configuration used for the documentation's Rust code examples and compare its output with the provided VS Code example. Determine which Rust syntax elements are currently indistinguishable; done means the documentation examples are visibly clearer and correctly highlight the relevant elements.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.