‹ BackHN Continuity

Thread

The GitHub wiki is an anti-pattern (2022)

175 points · 112 comments · ibobev

  1. chungy · · focus · HN ↗
    Fossil (<a href="https:&#x2F;&#x2F;fossil-scm.org&#x2F;home&#x2F;doc&#x2F;trunk&#x2F;www&#x2F;index.wiki" rel="nofollow">https:&#x2F;&#x2F;fossil-scm.org&#x2F;home&#x2F;doc&#x2F;trunk&#x2F;www&#x2F;index.wiki) solves this pretty nicely. You can have documentation as files or in a special wiki namespace and it&#x27;s versioned both ways, and every repository clone gets everything. Even better than that, your in-tree documentation files are rendered and browseable in exactly the same way as the dedicated wiki namespace.

    The linked URL to the home page there can even serve as an example: the &quot;trunk&quot; is a check-in name (<a href="https:&#x2F;&#x2F;fossil-scm.org&#x2F;home&#x2F;doc&#x2F;trunk&#x2F;www&#x2F;checkin_names.wiki" rel="nofollow">https:&#x2F;&#x2F;fossil-scm.org&#x2F;home&#x2F;doc&#x2F;trunk&#x2F;www&#x2F;checkin_names.wiki) that points to the newest check-in on the &quot;trunk&quot; branch. You can replace it with any other reference to get the old version; eg, version-2.20 would work to get the version 2.20 of the docs, 2015-03-14 would work to get the version from 14 March 2015, etc.

    1. YPCrumble · · focus · HN ↗
      Why is this easier or more effective than just a &#x2F;docs directory?
      1. gatlin · · focus · HN ↗
        Parent comment linked to that answer.
      2. chungy · · focus · HN ↗
        You absolutely can use &quot;just a &#x2F;docs&quot; directory in Fossil. You can even point the web server to &#x2F;doc&#x2F;trunk&#x2F;docs&#x2F;index.md or whatever other file names you want. :-)
Open on Hacker News to reply ↗

Unofficial Hacker News client; not affiliated with Y Combinator.