search

flake-parts / community.flake.parts

A `flake-parts` community website containing docs for various community modules
https://community.flake.parts
20 stars 1 forks source link

Upstream hardcoded module docs #1

Closed srid closed 12 months ago

srid commented 1 year ago

The following should be moved to their respective repos:

srid commented 1 year ago

@zimbatm Would you be comfortable accepting a PR[^1] upstreaming treefmt.md to github:numtide/treefmt-nix (as a separate .md file)?

It is currently hardcoded to contain the Docusaurus YAML frontmatter, https://github.com/flake-parts/community.flake.parts/blob/3dfeed785d10bfbe2222b234ca2960bde1c9b7b3/docs/modules/treefmt.md?plain=1#L1-L6

Which enables it to be rendered at https://community.flake.parts/treefmt-nix

This is all a bit hacky right now until we move to a better generic system for flake-module documentation (away from Docusaurus into using mdBook that builds from documentation exposed via flake output schema).

[^1]: Similar change in other module: https://github.com/Platonic-Systems/mission-control/commit/a177aea09cc933aed8bcfde5457364806c484bac