lark-parser/lark

Move documentation to bootstrap 5

Open

#1494 opened on Nov 30, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (4,275 stars) (384 forks)batch import
docsgood first issuehelp wanted

Description

At present the Shared Packed Parse Forest (SPPF) documentation makes use of bootstrap 4. Bootstrap 4 reached end-of-life on January 1, 2023. Therefore it would be nice to migrate the documentation to bootstrap 5.

Helpful links for the migration can be found in the corresponding Debian bug#1088592.

Contributor guide

Tech stack
htmlcss
Domain
documentation
Issue type
refactor
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.
1-3 hours
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
HTMLCSSBootstrap basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
The issue involves migrating the SPPF documentation from Bootstrap 4 to Bootstrap 5. The main file to update is `docs/ static/sppf/sppf.html`. The Debian bug report linked provides helpful migration resources. First, review the Bootstrap 4 to 5 migration guide to identify class changes. Then, update the HTML file accordingly, ensuring no broken styling. Test locally by opening the file in a browser.