Site: Rework Lua API appearance and functionality

[SlashScreen]

I aim to make the API docs easier to use and to look at. It is now one monolithic doc page, but the TOC should make it possible to navigate. I also aim to remove external markdown generation and make everything except the JSON generation itself within Hugo to have a single place to control all content and appearance.

• Rework API appearance
• Generate TOC
• Collapsible members
• Backlink generation
• Type parsing and backlink generation
• Polish (verb) appearance
• Restore TOCs to other generated sites like weapon defs and synced commands
• Remove Ruby scripts (sorry badosu)
• Test with Rml UI, since it has nested classes
• Optimize? (takes about a second to build the whole site, roughly 2/3rds of which is the API page, which I do not like)
• Optimize styles for maintainability and single place of control mantra.
• Document code, especially since templates are very difficult to read
• Make TOC look more similar to the hextra one? Do we care? It's been a struggle to do that.
• Fix favicon
• Finishing touches
• Aria labels

Comments are welcome, but I know I won't please everybody- and trying to do so is a futile effort.

(edit from @badosu) Deployed at https://slashscreen.github.io/RecoilEngine/docs/lua-api/

[ScarylePoo]

Just a heads up, the splinterfaction image is linking to https://beyond-all-reason.github.io/RecoilEngine/splinterfaction.info instead of https://splinterfaction.info/

[SlashScreen]

@sprunk @badosu ready for merge.

[badosu]

This is not a review pass.

A quick glance for some feedback:

1. Use the trick I was using for the css of the anchor link so the top menu does not cover the anchor position
2. Enums dont seem to be working

3. See: does not seem to be working

[SlashScreen]

Alright, I will take a look. Where can I see the trick?

This is not a review pass.

A quick glance for some feedback:

1. Use the trick I was using for the css of the anchor link so the top menu does not cover the anchor position

2. Enums dont seem to be working

3. See: does not seem to be working

[SlashScreen]

I see what's wrong with the see and the links, by the way; The permalink generator does not take the type of thing it is into account, so anything with the same name under the same scope will have the same link, whether it's an alias or a property. A simple enough fix.

[SlashScreen]

Also cc @rhys-vdw

[badosu]

Where can I see the trick?

https://github.com/beyond-all-reason/RecoilEngine/blob/master/doc/site/docgen/templates.rb#L10-L11

[SlashScreen]

What am I looking at here? is the margin-top span the trick?

Also, TODO: Add aria labels.

[rhys-vdw]

Can we get a link to a version of this on the web?

[rhys-vdw]

Markdown is getting flattened. You may accidentally be trimming the start of the doc lines.

This is mean to be a tree of nested lists.

[rhys-vdw]

Currently the design is absolutely dominated by the word "property", "table" and so on.

Can I suggest subduing it a bit?

[rhys-vdw]

Probably goes without saying, but this is not working:

Something more like:

alias Attachment

(“depth”|“stencil”|“color0”|“color1”|“color2”|“color3”|“color4”|“color5”…) 

Description here

---

[rhys-vdw]

Same deal here.

Could be:

class Menu

Base classes: Callins, Foo, Bar

Description here

[rhys-vdw]

Overall this is looking pretty sweet. I assume this is all on one page by popular demand, so I won't push back on that.

[badosu]

(“depth”|“stencil”|“color0”|“color1”|“color2”|“color3”|“color4”|“color5”…)

Note alias truncation has been resolved quite a while ago. I commented on discord, but this PR should reference and use the most recent version of emmylua (change pinned version).

[badosu]

Sorry, bad mouse press

[SlashScreen]

(“depth”|“stencil”|“color0”|“color1”|“color2”|“color3”|“color4”|“color5”…)

Note alias truncation has been resolved quite a while ago. I commented on discord, but this PR should reference and use the most recent version of emmylua (change pinned version).

Still happens with 0.13.0, I tested locally.

[SlashScreen]

Overall this is looking pretty sweet. I assume this is all on one page by popular demand, so I won't push back on that.

I know it's not ideal, but it's the easiest.

[rhys-vdw]

This feels like something that could be raised with emmylua (or even PR'd in) rather than hacked around here. Just a thought.

[SlashScreen]

I raised an issue about it. It either is truncated or the entire thing is in the type annotation. I’ll grab the issue when I’m back on my pc in a bit.

…

Message ID: ***@***.***>