adambard / adambard/learnxinyminutes-docs

[hdl/en] "hdl" is not a specific language

Open
#4,177 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Markdown
Stars
12.3k
Forks
3.7k
Avg merge
13h 10m
Merged PRs (30d)
6

Description

The [page on hdl](https://learnxinyminutes.com/docs/hdl/) is great to have, but it's a bit confusing to me because **HDL is not a language; it's a family of languages--VHDL and Verilog** being what someone is referring to the overwhelming majority of the time when they say "HDL". There is no mention of either VHDL or Verilog on the page itself, but in the resource links at the bottom, there is of course the Wikipedia page saying exactly what I said: HDL is a type of language, not a language.

It's like if there was a page on the site just for object-oriented programming, and all the code was written in Java, but there was no mention of the fact that it was Java, or even that Java was just a language that falls under OOP.

Contributor guide

Open the contributing guide

Research direction

Open the page on hdl linked in the issue and review its text alongside the resource links. Clarify that HDL is a family of languages and mention VHDL and Verilog on the page; done when readers can distinguish the category from the specific languages without relying on the external Wikipedia link.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.