Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[quickfort] overhaul quickfort alias documentation #1724

Merged
merged 6 commits into from Dec 12, 2020

Commits on Dec 6, 2020

  1. overhaul quickfort alias documentation

    - move the alias syntax and usage docs from dfhack-config/quickfort/aliases.txt to a proper guide written in RST. Add examples and more details.
    - move the alias library docs from data/quickfort/aliases-common.txt to the new guide
    - reorder aliases in aliases-common to match the order in the docs
    - factor out the character used to enter the stockpile config screen so we can use the same aliases for stockpiles and hauling routes (use 's' for stockpiles and '{Enter}' for hauling routes)
    - reference the new guide in the quickfort user guide
    - do an editorial pass of the quickfort user guide
      - change name to "Quickfort Blueprint Guide", but only in the text, not the filename, so we don't change the URL
      - add `quickfort-blueprint-guide` as a label, in addition to the existing `quickfort-user-guide`
      - changed table-like lists to actual tables
      - changed "grid" tables into "simple" tables where possible
      - used ':kbd:' markers whenever we refer to a single character
      - turned Meta blueprints and Notes blueprints sections into subsections of a new "Other blueprint modes" section, in preparation for a few new modes coming in -r5.
      - updated out-of date caveat about bookcases, display furniture, and offering places not being supported
    myk002 committed Dec 6, 2020
    Copy the full SHA
    025c9ff View commit details
    Browse the repository at this point in the history
  2. Copy the full SHA
    593d746 View commit details
    Browse the repository at this point in the history
  3. Copy the full SHA
    9612641 View commit details
    Browse the repository at this point in the history
  4. Copy the full SHA
    4ac6716 View commit details
    Browse the repository at this point in the history

Commits on Dec 9, 2020

  1. update changelog

    myk002 committed Dec 9, 2020
    Copy the full SHA
    ab815de View commit details
    Browse the repository at this point in the history

Commits on Dec 11, 2020

  1. address review comments

    - use :: shorthand where we can
    - clarify sub-alias docs
    - remove note about multiple modifier keys not being supported
    myk002 committed Dec 11, 2020
    Copy the full SHA
    45a9106 View commit details
    Browse the repository at this point in the history