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

Create adaptive docs #1

Open
syreal17 opened this issue Mar 6, 2020 · 0 comments
Open

Create adaptive docs #1

syreal17 opened this issue Mar 6, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@syreal17
Copy link
Contributor

syreal17 commented Mar 6, 2020

The idea: docs that take into account your setup and provide guidance accordingly. Can also provide advice on failures (of which vagrant up is prone)

Twine would be a good candidate for writing these sorts of docs given it's ability to mitigate complexity due to branching (usually for Interactive Fiction). It has some PL features that would help the cause of "damn good docs" as well.

Some example notes for quick start docs in this repo:

// choose your own adventure style.
// * choose 1. Quick, or 2. Deep
// * branch 1. Quick for prereqs needed or not... so on

@syreal17 syreal17 added the documentation Improvements or additions to documentation label Mar 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant