Open fdiblen opened 1 week ago
There is some info in the Explanation section of the docs, I don't know if you had found that yet.
If yes, then you think this fits there?
If no, then what would have made it easier to find this section?
Here is a simple explanation of files/folders in the template and the generated package
This setup helps anyone who wants to use or work on your package understand how everything is organized and find what they need easily.
Resource GitHub Documentation:
GitHub Guides on Repository Structure - Explains the basic structure of GitHub repositories, including files like README.md, LICENSE, and directories like docs, src, and test.
Hi @Kiunga1, thanks for the comment, but I'm not sure these are Julia specific comments. Are you using the template? Sorry to ask this, but is this comment generated by AI (e.g., ChatGPT)?
Description
Some users/developers may not be familiar with the files and/or project structure. It would helps users and developers if we have brief description for the template and the generated package.
For example for the generated package a user would have to following:
The description could be:
docs
: this folder contains the documentation of the project.make.jl
generates and deploys the documentationtest
: this folder contains the tests of the packageruntests.jl
: you can add your unit tests in this file