juspay / juspay/omnix

[Extended scope] Documentation generation

Open
#16 3 comments 0 reactions 0 assignees View on GitHub
extended scope
Dominant language
Rust
Stars
279
Forks
24
PR merge metrics
No merged PRs in 30d

Description

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 `description`s)?

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

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing README.md and the module option descriptions referenced in the issue to define the API-and-guide documentation scope. Then examine how the tool could be run locally and deployed publicly; done means an agreed approach can generate both documentation views and support those delivery modes.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
developer-experience, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.