‹ BackHN Continuity

Thread

The GitHub wiki is an anti-pattern (2022)

175 points · 112 comments · ibobev

  1. ghusto · · focus · HN ↗
    I've never understood why people even _generate_ from the docs folder. If you've written it in markdown (which they nearly always do) then it's already rendered properly in Github. Or is it because they then publish those docs somewhere else?
    1. etatester · · focus · HN ↗
      I think generation helps with content and structure that GitHub Markdown does not support, as well as having a dedicated (and brandable) website.

      An example:

      - source: <a href="https:&#x2F;&#x2F;github.com&#x2F;eslint&#x2F;eslint&#x2F;blob&#x2F;main&#x2F;docs&#x2F;src&#x2F;rules&#x2F;no-control-regex.md" rel="nofollow">https:&#x2F;&#x2F;github.com&#x2F;eslint&#x2F;eslint&#x2F;blob&#x2F;main&#x2F;docs&#x2F;src&#x2F;rules&#x2F;no...

      - rendered: <a href="https:&#x2F;&#x2F;eslint.org&#x2F;docs&#x2F;latest&#x2F;rules&#x2F;no-control-regex" rel="nofollow">https:&#x2F;&#x2F;eslint.org&#x2F;docs&#x2F;latest&#x2F;rules&#x2F;no-control-regex

      This is a very simple example, you can see how the code blocks are highlighted better and slightly interactive.

Open on Hacker News to reply ↗

Unofficial Hacker News client; not affiliated with Y Combinator.