Docs categories

[Efnilite]

Problem

Currently documentation is hard to index as all syntax elements are usually in a giant list with no possibility of organizing by type.

Solution

Allows syntax to be organized in docs.json by a few common categories. Here are some examples.

• The damage source module can use the damage source category,
• The breeding module can use the entities category,
• The vector module can use the math category.

These categories can be expanded on by (official) addons, in case a docs site needs them. Extending is as easy as implementing Category and adding your own fields using Category#of.

To allow getting the module with which a syntax was registered, a new method was added to AddonModule for mass registering syntax using the current module. This method is recommended instead of registering to a registry directly. The damage source module has been converted to the new registration API to showcase this.

Testing Completed

Manual testing.

Supporting Information

Adds a new field to the docs.json spec called category.

---

Completes: none
Related: none

[sovdeeth]

A syntax should be able to belong to multiple categories

[sovdeeth]

I might also like to see a tree structure for categories:

Math:
  ExprArith
  Vectors:
    ExprVectorLength

[APickledWalrus]

From a quick look 🙂

[Fusezion]

Was randomly going through the wip updated docs page again and noticed "category" checked it out saw that timespan and beacon effect are classified as apart of the "Display" category.

I decided to go check into this, this is caused by the usage guessing assignments with contains beacon effect contains display and timespan contains displayed.

Is this behavior planned to stay or do you plan to eventually move away from automatic assignments.
imo if something like this is to stay it should be checked against something more reliable

• Modules, which is already done with Categorizable
• Syntax patterns and not descriptions/names %display% vs. display

[sovdeeth]

I think excluding the description/examples, searching with \b word boundaries, and specifically looking for types in the syntax patterns would be good improvements.
On the docs side, I'd like to see these as selectable categories (think shopping websites) rather than exclusive lists of syntaxes. One syntax may naturally belong to multiple categories, and having a way to select various categories for display I think would improve the UI.