dfhack icon indicating copy to clipboard operation
dfhack copied to clipboard

Documentation for windows builds

Open cppcooper opened this issue 2 years ago • 2 comments

So take a look, that's the beginning of the windows build documentation section. Wouldn't it be nice if we had a table of contents? Perhaps a FAQ section and other improvements?

Perhaps we should separate the documentation of platform dependent builds to different files and keep very short sections in this file for each platform, which then link to their respective files. @lethosor I think you were leaning this way

@myk002 @ab9rf thoughts?

cppcooper avatar Jun 12 '22 22:06 cppcooper

So.. aside from the headings using an arbitrary order of a set of accepted heading underlines the rst's support localized content tables a la

.. contents:: Contents
  :local:
  :depth: 6

So separate files aren't necessary it seems. I'm going to take a crack at restructuring the windows help for the sake of clarity and simplicity.

cppcooper avatar Jun 14 '22 13:06 cppcooper

Sounds good. Thanks!

myk002 avatar Jun 14 '22 15:06 myk002