This package will be worked on and used by developers of all skill levels, so it needs detailed and thorough documentation. The structure of the documentation should be as follows:
README.md This is the entrypoint for getting started. It should include a high-level overview, outlining the project structure and steps to get the app running locally. It should be to the point, briefly mentioning each of the various concepts while linking to more detailed explanations in the ./docs directory.
architecture.md This document should provide details about the application architecture, including the various frameworks involved.
concepts.md This document should provide detailed information for the components of the codebase that are uncommon or novel.
Other documents which are more specific in nature can—and should!—be added to ./docs/ with appropriate snake-case names.