Skip to content

Title: Add AI-generated code documentation with Changelog for community feedback #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Title: Add AI-generated code documentation with Changelog for community feedback #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,17 @@ Contributions are welcome.
- Python 3.7+
- Pip
- Other listed in requirements.txt
## Documentation

## Running
This project uses automated tools to generate and maintain up-to-date documentation. The documentation is generated using AI, ensuring it reflects the latest changes in the codebase.

To generate the documentation, run the following command:

```bash
# Command to generate documentation
```

The generated documentation will be available in the `docs/` directory.

- Clone the repo using

Expand Down Expand Up @@ -85,4 +94,4 @@ uvicorn main:app
</p>
</td>
</tr>
</table>
</table>
1 change: 1 addition & 0 deletions requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,5 +52,6 @@ typing-extensions==3.7.4.3
ujson==3.2.0
urllib3==1.26.5
uvicorn==0.13.4
sphinx==4.5.0
watchgod==0.7
websockets==9.1