This repository has been archived by the owner on May 14, 2024. It is now read-only.
Code Documentation Improvements #7
Labels
Milestone
Comments
JosiahBull
added
documentation
6 tasks
JosiahBull
added a commit
that referenced
this issue
Mar 4, 2022
* refactor: Removed extraneous code to clear out for a final product. * Chore (license & versions): Enforced 2018 versions across the board, and standardised license with Rust official guidelines (C-PERMISSIVE). * refactor (festival): Refactored .wav generation code into it's own library, and made preperations to split conversion utilties into their own library. * feat (flite): Flite voices now supported by the api * feat (converters): Implemented a custom converter implementation. * fix (ci/cd): Fix to ci/cd pipeline. * test: Refactored integration tests. * fix (speed selection): Api now resupports speed selection. Speed selection was broken with the migration to flite from festival. It makes use of ffmpeg to alter the speed of audio. * feat (cache): Implemented a proper cache management solution. * fix (cache): Caching fully implemented, api tested and to be considered in full working order. * refactor (accounts): Removed all account tracking and rate limiting from api. * fix (docs): Update docs and docker with accountless setup * refactor: Improved efficiency of codebase, improving reponse times by ~30% removed extraneous files leftover from removal of accounts system, and improved the docker build system by creating a base image * Format Rust code using rustfmt * fix: patched a bug that was incorrectly caching files with differing speed values * chore: cargo fmt * docker: fixed minor docker build issues Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Description
Write documentation for all code modules, ideally with plenty of examples.
Ensure that the spec matches what's expected in the OAS spec, and write tests to validate this.
/src/cache.rsmay be excluded if #5 has not been resolved.Tasks/General Thoughts
The text was updated successfully, but these errors were encountered: