alopesmendes / alopesmendes/SpringRetrievalAugmentedGeneration
Code documentation
Open
@alopesmendes is already working on this.
Since Dec 29, 2025.
documentation
enhancement
- Dominant language
- Kotlin
- Stars
- 0
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
Created by
@alopesmendes
Assigned to
@alopesmendes
Goal
Write code documentation and be able to retrieve it in html or another format, also maybe a graph of dependencies.
Description
Write Kdoc and be able to visualize the documentation in a certain format.
Also look up for library's that will produce graph of the project.
Technical Notes
- Add dokka library to visualize code documentation
- Add another page in docs to explain how to visualize the documentation
- Check for graph's libraries
- Update and upload the html or other format of code comments
Libraries / Dependencies
No response
Definition of Done
- Respect the guidelines of the ticket
- Documentation is up to date
- Tests are valid and passing (unit, integration, e2e)
- Can be deployed without regressions
Enabler Type
Tooling
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.
Assessment
This issue has not been assessed yet.