Skip to content

Create adaptive docs #1

@syreal17

Description

@syreal17
Contributor

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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @syreal17

        Issue actions

          Create adaptive docs · Issue #1 · picoCTF/start-problem-dev