warriordog/mooltipage

Docs: Semantic HTML fixes

Open

#49 opened on Oct 4, 2020

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)TypeScript (4 forks)auto 404
documentationenhancementgood first issue

Repository metrics

Stars
 (1 star)
PR merge metrics
 (PR metrics pending)

Description

Some parts of the documentation don't make proper use of semantic HTML. These issues should be fixed:

  • Use page-section tag in index.html
  • Split p tags into actual paragraphs in all parts of getting started section
  • Move inline example code into figure tags (!! this might need CSS tweaks)

Contributor guide

Research direction
Review the documentation files for non semantic HTML usage. Replace generic divs with semantic tags like <section>, <figure>, and split long <p> blocks into multiple paragraphs. For the figure tag change, check if existing CSS or JavaScript targets those elements and adjust accordingly.
Tech stack
typescript
Domain
frontenddocumentation
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
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.
85