lf-lang / lf-lang/lf-lang.github.io

Ensure that all section headers are generic and not target specific

Open
#238 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
MDX
Stars
7
Forks
21
Avg merge
9h 46m
Merged PRs (30d)
2

Description

For instance under the Tracing page:
image

The sections "Tracing in C++" and "Usage" does not exist for the C target. Clicking those links will not make anything happen. It makes it hard to get an overview for articles with multiple target languages.

Contributor guide

Open the contributing guide

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 with the Tracing page and inspect its section headers and links for each target language. Check how headings are generated and how target-specific sections are organized. Done means the headers are generic and the links provide a consistent overview across target languages.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.