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.

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

[Discussion] Proposed Directory Structure #16

Open
pritkc opened this issue Nov 6, 2024 · 6 comments · May be fixed by #17
Open

[Discussion] Proposed Directory Structure #16

pritkc opened this issue Nov 6, 2024 · 6 comments · May be fixed by #17
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@pritkc
Copy link
Collaborator

pritkc commented Nov 6, 2024

Current dir in prod: directory_structure.txt

To make our project easier to navigate and more organized, I’m proposing a directory restructure that aligns with industry standards. Key ideas:

  • All manuals, guides, and images under docs, with clear subfolders (like manuals, api, and images).

  • Group src by language (e.g., mole_C++ and mole_MATLAB) and within each, organize files by functionality (like operators, solvers, utils).

  • Have dedicated examples and tests folders with language-specific subfolders.

  • A proposed structure inspired from the LIBCEED repo:

image

Open to thoughts and feedback!

CC @valeriabarra

@valeriabarra
Copy link
Collaborator

Hi @pritkc, thank you for creating the Issue and outlining the proposed structure.

I agree, it would be better to move to a different model. I like libCEED's organization.

Just one minor comment. Perhaps I would remove the "manuals" subdirectory, as all those Markdown files there, including guides, will constitute the main User Manual anyways (eventually we won't have the scattered PDF files anymore. Their source will be included in the User Manual content).

Any objections/comments on the proposed structure?

cc: @jbrzensk

@jbrzensk
Copy link
Collaborator

jbrzensk commented Nov 6, 2024

I'm a little confused. Outside of the documents folder, isn't the proposed structure the current folder structure?

I like the doc folder suggestions.

@pritkc
Copy link
Collaborator Author

pritkc commented Nov 6, 2024

I'm a little confused. Outside of the documents folder, isn't the proposed structure the current folder structure?

I like the doc folder suggestions.

Hi @jbrzensk,

You're absolutely right. The main updates are in the documentation, where I've added detailed comments. The bullet points above outline the overall blueprint for the final outcome.

@valeriabarra
Copy link
Collaborator

Okay. Sounds good. @pritkc you can proceed with the proposed outlined docs structure (I would just remove manuals).

Please create a PR when ready with the new file organization and, in the PR description, use verbiage that will link/pair it to this Issue, such as

Will close #16

So that GH automatically associates the PR to this Issue. Thanks!

@pritkc
Copy link
Collaborator Author

pritkc commented Nov 12, 2024

I've posted a branch here: https://github.com/csrc-sdsu/mole/tree/folder-restructure.
I still need to update the affected paths, which I’ll handle in a PR once the proposed structure receives preliminary approval.

@valeriabarra
Copy link
Collaborator

Hi @pritkc , thank you for your work.

It looks good for me now. Eventually, as discussed, we will remove the "manuals" subdirectory, as those PDF files will be embedded in the documentation/User Manual source anyways.
You can go ahead. Thank you.

@pritkc pritkc linked a pull request Nov 13, 2024 that will close this issue
@pritkc pritkc added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 13, 2024
@pritkc pritkc self-assigned this Nov 13, 2024
@JananiPSrinivasan JananiPSrinivasan self-assigned this Nov 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants