stackabletech / stackabletech/crddocs

Fix code block formatting

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

Nobody has claimed this yet.

Dominant language
CSS
Stars
0
Forks
1
PR merge metrics
No merged PRs in 30d

Description

There is some code in schemars which messes up code block formatting. There is an outstanding PR upstream, it would be great if that would get merged: https://github.com/GREsau/schemars/pull/251

Otherwise a workaround is to use #[schemars(description="...")] as it doesn't process the text in the same way.

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

Start by reviewing the referenced schemars pull request #251 and determine whether its fix is available. Compare the affected code block formatting with the current output; done means the formatting issue is resolved without relying on the description workaround.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 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.