OpenAPITools / OpenAPITools/openapi-generator

[REQ] Better Julia document organization:

Open
#18,595 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: Feature
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Is your feature request related to a problem? Please describe.

I noticed that the documentation generated by julia-client openapi-generator generates a separate .md file for each Response Object, but this is not easy to organize and may generate hundreds of separate .md files in the docs directory.

More importantly, existing document generation does not integrate well with docuenter.jl. You need to manually create make.jl and add entries to the file.

Describe the solution you'd like

  1. Merge Response Results Object documents for individual API end-points, for example, tv-series-watch-providers, we can merge these Response Results Object document to one page. This way the document doesn’t look unorganized.

image

  1. Add built-in documenter.jl support, once documents are generated, it should provide everything for build web pages

Additional context

If you think these ideas are good, I can take a look at the code and open a PR (if I can understand it)

cc: @tanmaykm

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the generated files in the docs directory, including DefaultApi.md, and the manually created make.jl used with documenter.jl. Define how endpoint response objects should be merged and what built-in documenter.jl support must generate; done means organized endpoint documentation and web-page build support without manual make.jl entries.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, julia, openapi
Domain
documentation, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.