search

juspay / omnix

🚧 A Nix wrapper to improve developer experience
https://omnix.page
GNU Affero General Public License v3.0
71 stars 4 forks source link

[Extended scope] Documentation generation #16

Open srid opened 1 year ago

srid commented 1 year ago

Can this tool help generate API-cum-guide documentation? Like https://zero-to-flakes.com/process-compose-flake/ (from say README.md) and https://flake.parts/options/process-compose-flake (extracted from module option descriptions)?

We can spin it up like hoogle locally, as well as deploy it to a public site.

srid commented 1 year ago

Note: all of https://dioxuslabs.com/learn/0.4/ (which looks/behaves like Docusaurs) is generated in pure Rust+wasm (uses https://github.com/dioxusLabs/include_mdbook evidently). With Leptos, we could do the same with SSR (server-side rendering).

srid commented 1 year ago

If done right, this could supplant all of https://github.com/flake-parts/community.flake.parts

srid commented 1 year ago

"Documentation generation" can simply be a subset of what nix-browser does, which also includes actions (eg: build this package, run that program).

So when the user generates a static site, only documentation is produced, with interactive actions disabled.