Rules_nodejs: Update documentation style

[UebelAndre]

🚀 feature request

Relevant Rules

Description

The documentation is incredibly difficult to parse and seem quite different from every other set of rules

rules_swift
rules_cc
rules_rust

Describe the solution you'd like

The documentation should be restructured such that each rule has a table that describes all of it's attributes

Describe alternatives you've considered

I'm not sure what the workaround should be. My reference to rules_cc is just a suggestion. There's likely a bunch of ways to improve readability but I do feel it's a problem with these rules.

[mattem]

Thanks for the issue, we spoke about a design refresh in our teams meeting today, so this is good timing.
I think this is something we can look into doing, there are a few other bits that need fixing with the doc generation too while we are in there.

[UebelAndre]

@mattem Hey, thanks for the quick reply 😃

Is there an issue tracking those things you mentioned you want to do?

[mattem]

I don't think there are separate issues for each item on the list, but this is what springs to mind:

• Docs search isn't working #1282
• Since switching to stable as the default branch, it's a manual step in the release to push to master for the doc site
• There are references to the internal //packages labels still in some documented rules and examples, we should apply the same substitutions to the docsgen as to the published packages
• In order to flip --incompatible_no_rule_outputs_param, we need to address some doc generation issues around macros #1303

Also, it kinda irks me that there isn't a consistent style for the canonical rule sets in the bazelbuild org, but that's outside the scope here I think.

I should mention that I started working on making the docs look more like the main bazel.build docs, which seems a good fit for the larger docs that rules_nodejs has

[UebelAndre]

@mattem Awesome! All those things sound super exciting! Thanks so much for sharing, I really appreciate it 😃

[mattem]

To keep this issue updated, first pass of the refreshed docs are here, working on the final tweaks and fixes currently.
https://mattem.github.io/rules_nodejs/

[UebelAndre]

It's gorgeous!! 🤩

[mattem]

2122 now merged, and live at https://bazelbuild.github.io/rules_nodejs/

I think I'll close this, and we can now open more focused issues for follow up items

[UebelAndre]

It looks way better! Thank you so much!