Description: The current codemelted.rs README provides a basic introduction to the overall project. Create a new UML diagram that shows the linkage between the main use case API functions, supporting rust constructs, and their linkage 3rd-party API at a high-level (a.k.a not the individual details just the 3rd party crate). Integrate this into the README.md file and update it to flow the introduction into the drill down into the individual API details already documented.
NOTE: This will also serve to identify what future work is needed to complete the codemelted.rs module.
Acceptance Criteria:
- When a new UML introduction diagram showing the main structure of the
codemelted.rs module exists.
- When that diagram is integrated into the
README.md
- When "missing" future features are identified and issues created for future work.
Description: The current
codemelted.rsREADME provides a basic introduction to the overall project. Create a new UML diagram that shows the linkage between the main use case API functions, supporting rust constructs, and their linkage 3rd-party API at a high-level (a.k.a not the individual details just the 3rd party crate). Integrate this into the README.md file and update it to flow the introduction into the drill down into the individual API details already documented.NOTE: This will also serve to identify what future work is needed to complete the codemelted.rs module.
Acceptance Criteria:
codemelted.rsmodule exists.README.md