GenieFramework / GenieFramework/SwagUI.jl
is there anyway to automate process of document generation?
Open
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 19
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
something like django you add swagger to the project and then you can add a new url which includes all other urls and so you have a documentation ready for all endpoints at once without doing it manually like SwaggerMarkdown here
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing SwaggerMarkdown workflow and the current Swagger UI integration in SwagUI.jl. Define how a single URL would discover all project routes and generate endpoint documentation without manual additions; done means the complete route set is documented through that URL.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100