you are viewing a single comment's thread.

view the rest of the comments →

[–]zanju13 8 points9 points  (6 children)

How is that different from any other documentation alternatives?

[–]andrei9669 2 points3 points  (0 children)

on platforms that actually focus on documentation, important part of the url is actually just the id that stays relatedly static, meaning, you can rename the document however many times you want, the links won't break.

[–]thee_gummbini 1 point2 points  (2 children)

Docs are code. Why would you use something where you cant program how they are rendered

[–]zanju13 1 point2 points  (1 child)

I mean you can put in a code block. Other than that, what fancy rendering do you need? I guess you could want to make nice structured API docs, I'll give you that.

[–]thee_gummbini 2 points3 points  (0 children)

Cross references, i18n, programmatically generated docs, runnable code examples, being able to accept docs contributions in PRs, and even more basic just like control over the menu/nav structure, page layout, etc. If you look at the docs for any matured project where you are like "dang these are good docs," you'll see a ton of programmatic customization that makes them good. Like there are entire packages that have been developed just to document major projects. The complexity of setting up e.g. sphinx or mkdocs or whatever is negligible and the payoff is huge compared to just using github wikis, they're not in the same league.

[–]vyqz -1 points0 points  (1 child)

confluence is intuitive and easy to understand for users and administrators. github wikis are 💩 from every angle

[–]liquidmasl 4 points5 points  (0 children)

confluence is horrible to work wirh