Feature Request: Integrated Markdown User Manuals for Forge Rulesets

[Mephisto]

Hi everyone,

I’d like to pitch a quality-of-life feature for both Forge Crafters and players: Native Markdown User Manuals integrated directly into custom rulesets.

Currently, when we release or update a ruleset, providing documentation usually means directing users to an external Wiki, a Google Doc, or a long forum thread. It would be incredibly helpful if a specific directory could be created within the ruleset structure where developers could simply drop a Markdown (.md) file.

Ideally, this Markdown file would be automatically parsed and made accessible directly from the VTT - either via a button on the Start Screen before loading into the campaign, or somewhere easily accessible within the active ruleset itself.

### Why this would be beneficial:

Version Syncing: The manual always matches the downloaded version of the ruleset.

Ease of Creation: Markdown is lightweight and standard for software documentation, making it very easy for Crafters to maintain alongside their code.

Would love to hear if other developers would find this useful, or if the SmiteWorks team thinks this is feasible to implement!

[anstett]

There is a similar thing currently in the 2e ruleset.

Not exactly this but is updated inside of FG.

[Trenloe]

Would love to hear if other developers would find this useful...

I think this is a great idea! Of course, it relies on users actually reading and digesting user guides, but that's for another discussion... And people (like me) updating them...

EDIT: I think this is a great idea not just for Forge material, but any FG product.

EDIT 2: Please add to the feature request list and post a link here so others can vote on the request.

[Mephisto]

There is a similar thing currently in the 2e ruleset.

Can you share some details how it is done there?

[Mephisto]

Here is the feature request link.

[anstett]

@Celestian has a kept up a Book that auto loads in the ruleset.

Called AD&D 2E Ruleset Documentation is a FAQ for everything.

[Trenloe]

Here is the feature request link.

Great, thanks! Go vote!