Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Package needs documentation #1

Open
zbiller opened this issue May 20, 2024 · 0 comments
Open

Package needs documentation #1

zbiller opened this issue May 20, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@zbiller
Copy link
Member

zbiller commented May 20, 2024

We'll do this inside a separate repo https://github.com/neurony/crudhub-docs which we'll reference in the readme.md of this repo.

That repo will only contain md files revealing the documentation as per this example:

  • installation.md -> will outline the installation steps
  • crud.md -> will outline how the crud generation works
  • etc.
@zbiller zbiller added the documentation Improvements or additions to documentation label May 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@zbiller