Write technical documentation for dotAI
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 970
- Forks
- 486
- Avg merge
- 3d 33m
- Merged PRs (30d)
- 170
Description
Task
A document that explains the different components, APIs (REST, Java) and interaction with the persistence layer and the OpenAI (or other) API is needed so any back-end developer can use it to solve upcoming issues and write new functionality.
Proposed Objective
Please Select
Proposed Priority
Please Select
Acceptance Criteria
A new document that includes the technical details and explanation needed for devs to understand the design better and be able to fix bugs, and write new functionality for the dotAI feature.
External Links... Slack Conversations, Support Tickets, Figma Designs, etc.
No response
Assumptions & Initiation Needs
No response
Quality Assurance Notes & Workarounds
No response
Sub-Tasks & Estimates
No response
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.
Research direction
No files, tests, or entry points are named. Start by locating the dotAI components and tracing its REST and Java APIs, persistence layer, and OpenAI or other API integration. Done means a new document explains the design and technical details well enough for back-end developers to fix bugs and add functionality.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- backend-api-design, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100