core: universal-box doc-db
command
#164
Labels
enhancement
New feature or request
hacktoberfest
marks issues which are accepted under hacktoberfest
🤔Needs discussion
Open to further discussions
Is your feature request related to a problem you're trying to solve with Universal-Box? Please describe.
This issue aims to address the need for comprehensive documentation for various databases within the Universal-Box project. Currently, users may find it challenging to understand how to integrate and utilize different databases effectively in their projects. By automating the documentation process, we can provide clear and accessible information.
Describe the solution you'd like
I propose creating a command-line tool that generates markdown documentation for popular database schemas. The initial focus will be on Prisma, but the tool should be designed generically to accommodate other databases as well. The tool will read the database schema files, parse the models and enums, and output a markdown file documenting the schema.
Expected Features:
Describe alternatives you've considered
An alternative approach could be to manually document each database schema in markdown files. However, this would be time-consuming and prone to inconsistencies. Automating this process will ensure that documentation is always up-to-date with the latest schema changes.
How would this feature improve Universal-Box?
Implementing this feature will enhance the usability of Universal-Box by providing users with clear and concise documentation for integrating various databases into their projects. This will streamline the onboarding process for new users and reduce confusion around database configurations.
Additional context
The generated markdown files should include:
The text was updated successfully, but these errors were encountered: