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

Allow individual modules to publish documentation #162

Open
srid opened this issue Feb 22, 2023 · 1 comment
Open

Allow individual modules to publish documentation #162

srid opened this issue Feb 22, 2023 · 1 comment

Comments

@srid
Copy link
Contributor

srid commented Feb 22, 2023

This is like #75 - but covers arbitrary documentation - like a tutorial/howto series - but organized in Diataxis framework. So for example, haskell-flake can publish its own tutorials and howtos and they ultimately render nicely in https://flake.parts/ ...

@roberth
Copy link
Member

roberth commented Nov 23, 2023

In #627 I added some (stone age) logic to generate the navigation menu for the options docs (reference docs). The same could be done for tutorials, guides and explanations.
Perhaps the inputs could provide directories containing

In render.inputs.<name> we could have an option docs as nullOr path, referring to a directory.
This directory would then contain

  • tutorials.json: mapping from title to file
  • tutorials/: directory containing those markdown files
  • guides.json ... same idea ...
  • ...
  • intro.md: for the intro in the reference docs

It could then be copied to the right places and we can generate the menus with the json.

EDIT: added intro.md

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

2 participants