Open thombruce opened 2 weeks ago
Documentation might be best handled after I've created Dynamite (a CMS intended to work with TNT).
Or... Documentation reworks might be a good test case for the development of Dynamite. I want to be able to... edit content, rename it, delete some, move it around (not yet possible).
Depends on how critical we think the docs rework is, because development of Dynamite might take a while. But worth considering.
One key change:
Components that are only included with a submodule (e.g.
@thombruce/tnt-content
) should not be listed at/docs/components
but instead at some module-specific path to avoid confusion.Consider...
Or consider doing away with the
docs/
path entirely:Or...
Or just...
Alternatively... do list all components at routes like
/components/component-name
but add an info card where relevant to indicate that a module should be installed to use the relevant components. Then allow the/components
page to receive a filter via URL query arguments to filter those components relevant to specific modules.It is a docs site, so I don't think the inclusion of a
docs/
path is really necessary, even if we do also haveblog/
,credits/
,settings/
and so on.A decision does need to be made above, and I suggest taking some inspiration from other libraries - how does Tailwind document its submodules? How does Nuxt? I know that one, actually; typically at a different subdomain.