Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplify what it takes to write module docs #6

Open
2 of 8 tasks
srid opened this issue Jan 23, 2024 · 1 comment
Open
2 of 8 tasks

Simplify what it takes to write module docs #6

srid opened this issue Jan 23, 2024 · 1 comment
Assignees

Comments

@srid
Copy link
Member

srid commented Jan 23, 2024

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. haskell-flake.md should just be index.md (see Combining multiple notebooks srid/emanote#494); and haskell-flake/*.md should all be moved to top-level Simplification 1: index.md #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
Copy link
Member Author

srid commented Feb 9, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant