Build jsdoc with HTML output
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- javascript
- Domain
- documentation, tooling
Research direction
The issue names the build jsdoc task and generated api.json files but no source file or test. Start by tracing that task and the api.json flow; done would be a documented way to consume the files or a defined HTML-output or plugin path, with validation for the chosen behavior.
Written by the indexing model from the issue text.
Description
Hello,
I'm currently trying to gather our companies custom UI5 implementations in reusable libraries and host an internal API documentation for them.
I found the "build jsdoc" option to build documentation alongside the libraries but it only outputs api.json files which somehow should be able to be inserted into the UI5 SDK and viewed there?! But there is no documentation on how to do that either.
Are there plans to include a HTML output to the build jsdoc task or a custom plugin for jsdoc itself to support UI5 Syntax?
On the other hand a guide on how to handle the generated api.json files would help too i guess.
- Dominant language
- JavaScript
- Stars
- 511
- Forks
- 83
- Avg merge
- 1d 5h
- Merged PRs (30d)
- 55
Contributor guide
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.
More from UI5/cli
-
module/ui5-builder
-
Build cache: buildThemes cache is invalidated by irrelevant library.js / .library content changes Openmodule/ui5-builder module/ui5-fs module/ui5-project
Difficulty 3/5 1-2 days Newbie friendliness 76/100
-
module/ui5-project
Difficulty 4/5 3-5 days Newbie friendliness 64/100
-
roadmap
Similar issues
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
babalae/bettergi-scripts-list#3674 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
vadimdemedes/ink#1029 ·
-
code-quality refactoring
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
github/gh-aw-firewall#8816 ·
-
integration:quickjs org:external priority:backlog topic:code-interpreter topic:middleware type:feature
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
langchain-ai/deepagents#6450 ·
-
optimization optimization:agents-md-curator
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
githubnext/gh-aw-cao#13143 ·