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: document marker mode and buildingplan #1634

Merged
merged 4 commits into from Sep 14, 2020

Conversation

myk002
Copy link
Member

@myk002 myk002 commented Aug 27, 2020

#499
also a bit of cleanup and reorg

Copy link
Member

@lethosor lethosor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you planning on making changes to this in the near future? I would like to convert this to RST and get it into the main DFHack docs so that other pages can cross-reference it instead of linking to the page on GitHub, but I don't want to conflict with any changes you're making at the same time.

@lethosor lethosor added this to In progress in 0.47.04-r3 via automation Aug 29, 2020
@myk002
Copy link
Member Author

myk002 commented Aug 29, 2020

Are you planning on making changes to this in the near future? I would like to convert this to RST and get it into the main DFHack docs so that other pages can cross-reference it instead of linking to the page on GitHub, but I don't want to conflict with any changes you're making at the same time.

No immediate changes to this file planned. I'm writing a section on advanced blueprints, but I'm currently just getting a draft together as a google doc. once it's ready, I can add it to whatever format the user manual is in then. Thank you for converting this to RST!

@myk002
Copy link
Member Author

myk002 commented Sep 1, 2020

Is it possible to put the rst version of this guide in the scripts repo? It's fine if not, but it would be nice to be able to document a feature in the same PR that I implement it

edit: since this PR was still open I did one final editing cleanup pass and added docs for dig priorities : p No more changes planned.

@lethosor
Copy link
Member

lethosor commented Sep 2, 2020

It's technically possible, yeah, since the documentation "root" is the root of the DFHack repo (leading to the /docs/ prefix in many pages like https://docs.dfhack.org/en/latest/docs/Documentation.html, which I'd like to get rid of, but that's another matter). You would still need to build the docs from within a DFHack clone, but some docs could be in the scripts repo.

There are a couple pages from df-structures included in the docs:

These are linked to from https://docs.dfhack.org/en/latest/docs/Structures-intro.html links to them (source)

As for where to put it, there aren't really files like this in the scripts repo yet, but maybe a docs subfolder could work.

(And no worries about the edits, I haven't gotten around to doing this yet. Assuming you're ok with me doing it, I'll move it to the scripts repo as described above)

@lethosor lethosor self-assigned this Sep 2, 2020
@myk002
Copy link
Member Author

myk002 commented Sep 6, 2020

Totally ok with me to move the user guide content to the scripts repo. Maybe just change this file to contain a pointer to the online location of the user guide.

@lethosor lethosor merged commit 6e9c209 into DFHack:develop Sep 14, 2020
0.47.04-r3 automation moved this from In progress to Done Sep 14, 2020
@myk002 myk002 deleted the quickfort_docs branch September 14, 2020 04:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
0.47.04-r3
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

2 participants