[FEATURE]: Extract main README contents to separate files #151
Labels
kind/documentation
Improvements or additions to documentation
kind/enhancement
New feature or request
priority/low
An issue with the product that doesn't impact the user much or not at all (ie tech debt)
Details
Is your feature request related to a problem? Please describe.
The main README is very long, it might be better to extract some of the information to separate files. I think the main
README
should serve as an index/pointer to any information you want, and mainly focus on describing the PoC and maybe listing the requirements.Most of the information added in #140 involves instructions, I think it would be better to extract this to a separate file e.g.
INSTRUCTIONS.md
/USAGE.md
/SETUP.md
/GUIDE.md
/etc. I'd personally move everything in the "Proof of Concept Edge use case with ACM" section to a separate file(s), apart from this description which would be helpful to have in the mainREADME
:ai-edge/README.md
Lines 21 to 23 in 0f86d5c
Describe the use-case or expected workflow
Describe alternatives you've considered
Could just not do anything ¯\(ツ)/¯
Additional context
N/A
The text was updated successfully, but these errors were encountered: