doc: restructure module rendering

[Flameopathic]

changes:

• changes rendering order and style of module documentation elements
• adds meta.homepage
• adds meta.description
• removes existing README.md files
• documents added meta attributes

related: #883

Things done

• Tested locally
• Tested in testbed
• Commit message follows commit convention
• Fits style guide
• Respects license of any existing code used

[0xda157]

shouldn't we just have a package meta attribute and get the homepage from the meta of the package?

[Flameopathic]

shouldn't we just have a package meta attribute and get the homepage from the meta of the package?

we could, though this wouldn't work for targets without packages like Nixvim for example

[0xda157]

though this wouldn't work for targets without packages like Nixvim for example

we can have package be null or derivation and homepage be null or string and have homepage default to package.meta.homepage.

[Flameopathic]

we can have package be null or derivation and homepage be null or string and have homepage default to package.meta.homepage.

that would work, though i'm not sure how to implement defaults in this context.

[0xda157]

that would work, though i'm not sure how to implement defaults in this context.

something like meta.homepage or meta.package.meta.homepage

[Flameopathic]

i am satisfied with how this should function, but i am not sure how to test how this is going to render.

[Flameopathic]

one side effect of the way that this will render the hyperlink is that all link text is lowercase because most of it comes from the package names.

in addition, the most recent commit changes nearly every meta.nix file. this may make merging with treewide-init-maintainers more difficult.

[Flameopathic]

using packages to get homepages is posing an issue on Darwin. i believe it is because some packages aren't available for Darwin. i have disabled the docs check on Darwin because i can't think of how to properly fix this, but this is probably not a good way to move forward. help would be appreciated.

[danth]

i am not sure how to test how this is going to render

nix build .#docs && xdg-open ./result/index.html

[MattSturgeon]

Otherwise looks good 👍

[danth]

I discovered in #1212 that the font options accidentally include the actual packages in the docs instead of literalExpressions, so I opened #1225 to fix that

Note that this fix has been merged :))

[Flameopathic]

I discovered in #1212 that the font options accidentally include the actual packages in the docs instead of literalExpressions, so I opened #1225 to fix that

Note that this fix has been merged :))

I would rather save it for another PR with how much this one does.

[danth]

Looks good to me. Thank you :))

Outdated