flake-parts / community.flake.parts

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

Simplify what it takes to write module docs #6

Open srid opened 9 months ago

srid commented 9 months ago

The README has this footnote,

image

In particular, we want to obviate the user from having to do this (using https://github.com/srid/haskell-flake/tree/master/doc as example):

  1. [x] haskell-flake.md should just be index.md (see https://github.com/srid/emanote/issues/494); and haskell-flake/*.md should all be moved to top-level #18
  2. [ ] In the index markdown we have this YAML meta, that should not be needed either: image
  3. [ ] A convenient nix run ... command to preview local module docs with the rest of the site using standard flake inputs (for other module docs).
  4. [ ] Checks
srid commented 8 months ago

The layout part is fixed; now we need to address the extraneous YAML frontmatter part.