dice-roller / documentation Goto Github PK

The CDN link, and the Older Browsers section only shows using the minified version. we should also show that there's a non-minified version to use, if they wish.

The UMD example in the number generator example is still using the full path, whereas that's not necessary anymore.

This should be changed to just the package name.

Also check other pages to see if it's like that elsewhere.

This PR has made it so that the compare point on some modifiers is no longer required: dice-roller/rpg-dice-roller#288

Once released, the documentation needs to be updated to reflect that.

The Contributing section only covers contributing to the library itself, and there is no information on how to help out with the docs.

See if we can generate the API section directly from the code, and merge it with vuepress.

It would be good if we could get this in a git hook within the library repo, that compiles and pushes to this repo .

On https://greenimp.github.io/rpg-dice-roller/api/RollResult.html at the top, it says:

You will probably not need to create your own RollResult instances, unless you're importing rolls, but RollResult objects will be returned when rolling dice.

This would be better placed inside either a "tip" or "warning" container, so it's more visually noticeable.

A new <> (Not equal to) operator will be going out in the next release (Likely 5.1.0). This needs to be added to the docs.

This should also be added as a workaround for exploding when not equal to a value.
And also update the examples and add a note in the Compare Point section.

There's currently no information on how to export and import dice rolls on the DiceRoller and DiceRoll objects, other then briefly in the API section.

There should be examples, and proper descriptions in the usage section.
Also links in the features list.

Group rolls will be released in v4.5.0 of the dice roller, so we need to add documentation on how to use them.

After upgrading to Vuepress v2, the DocSearch / Alogolia search is no longer working. I'm currently in discussion with Algolia to get it running again, but wanted to raise it here in case anyone else wondered what was going on.

Currently, the CommonJS instructions have examples for both Node 12+ and Node < 12.

The library doesn't support Node < 12, however the browser support section notes that it should work on Node 11 as well.

We either need to;

• Remove all references to Node < 12 in the setup instructions, and change the browser support notice to state that we only support 12+
• Or, add a note on the setup guide to check the browser support section

The die objects aren't described in the API section. It would be sensible to add a page for dice which explains the basic interface for the StandardDice, explains that they're all the same interface, but with some slight difference it return values.

On https://greenimp.github.io/rpg-dice-roller/api/DiceRoll.html#prototype-methods the rolls() method should be roll().

The roller does technically allow math only rolls like, 4+6.

Should we document this behaviour, or is it superfluous?

https://vuepress.vuejs.org/theme/default-theme-config.html#algolia-search

In the examples, the "average total" example uses the minTotal property, rather than averageTotal:

// get the average total:
console.log(`Average total: ${roll.minTotal}`);
// Average total: 66

Should be:

// get the average total:
console.log(`Average total: ${roll.averageTotal}`);
// Average total: 66

It could be beneficial to have an upgrade section, detailing how to upgrade from v4 to v5.

As discussed here dice-roller/rpg-dice-roller#238
The dice roller's round() method (Internally MathJS handles rounding of negative numbers differently to Javascript's Math.round()

This should be documented here https://dice-roller.github.io/documentation/guide/notation/maths.html#functions

The sponsor button is currently only on the homepage, but it would be good if we could add it to every page.

The documentation website is missing the favicon. We should look at getting this added in.

For some reason, the latest version of the docs isn't responsive and doesn't look correct on small screens.