lenra-io/docs

[Task] Add links to titles

Open

#86 opened on Mar 2, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)CSS (0 forks)auto 404
enhancementgood first issuehacktoberfest

Repository metrics

Stars
 (5 stars)
PR merge metrics
 (PR metrics pending)

Description

What should be done

Add a link to all the h2+ titles.

Technical recommandation

The markdown generates an id on title but not pug. A id should be added when not present.

Ecological concerns

Avoid JavaScript event.

The best solution is to add the ID at compile time but it could be complicated...

If not possible, run JS to add the links when the page is loaded.

Contributor guide

Research direction
Investigate how to add IDs to headings in pug templates at compile time, or else add JavaScript to add links on page load. Check the existing pug files for heading patterns.
Tech stack
html
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
HTML
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75