Skip to content

Feature Request: ruleset agnosticize the documentation #475

Open
@MysticDaedra

Description

@MysticDaedra

As the documentation stands at this moment, it seems to heavily use Starforged as its base. I have qualms about that on its own (base should be Ironsworn, Starforged is an expansion or alternative to Ironsworn rather than an update or second version), but regardless, it's confusion when going through the documentation, especially the Getting Started tutorials, to know which functions are meant to be used with Starforged and which aren't etc. It's also a bit disconcerting to be following along and suddenly see Starforged brought up as if the reader is playing Starforged... but they aren't (or at least might not be), and then you don't know if you've been doing it right for whichever ruleset you're following.

I'd recommend that any specific mention or use of a ruleset in the documentation, especially the Getting Started pages, be agnosticized or at least use Ironsworn instead of Starforged. If there are special things to know about specific rulesets, add in a note or something to indicate that some info is meant for that ruleset, rather than being a general thing.

Current example: the entire 05 Build a Starting Sector uses Starforged exclusively and specifically, although obviously someone could extrapolate the information they need from that for other rulesets. But, despite not being a coder or dev or anything, I do consider myself pretty technically competent, and I have a hard time myself figuring out what parts are for Starforged and what parts are for Ironsworn. It's also a bit off-putting to be following a Getting Started tutorial that seems to be for Starforged instead of Ironsworn... when the name of the vault is Iron Vault, not Star Vault... IDK, I just feel like this should be changed. I'd do it myself if I knew how/was allowed to.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    • Status

      No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions