Visualization of django-crm's codebase

[ivanmilevtues]

I generated a diagram representation of the django-crm codebase: https://github.com/CodeBoarding/GeneratedOnBoardings/tree/main/django-crm

The idea of the diagram is to give people an easy way into the codebase. Showing what the main components are and how they interact with eachother gives a high-level understanding of how things work for new people. Then they can focus on the component of interest and start building their knowledge from there.

I would love to hear your feedback on the idea and execution! If you like it, I'd be more than happy to do a PR, where I integrate the diagrasm in your /docs + our free github action to keep them up-to-date.

Full disclosure: we're trying to turn this into a startup, but we're still in a very early stage and figuring out what will actually be useful for people.

[DjangoCRM]

This is a good idea.
And even at this early stage it might be useful for new developers.
It's hard to say now, but the comments will show.
Be sure to let me know when there's an update.

[ivanmilevtues]

Thanks for the comment. I am looking forward to people's comments. Do you like the idea of diagram first documentation in general?

[DjangoCRM]

Yes, I like this idea.
In addition to the main goal, it would be good to use the project keywords. This could help in SEO promoting the project and understanding its categories by users.
For example, the following can be used in the description of the corresponding modules:

• This is an Analytical CRM because it has a powerful Analytics module.
• The Massmail module is a main component of this Mailing CRM.

I'll be waiting for your updates.

[ivanmilevtues]

Hey @DjangoCRM wanted to update you that we are now also open-source: https://github.com/CodeBoarding/CodeBoarding

The key-words point I think makes perfect sense and I've written it down as feedback and we will get into it!

We've done quite some improvements over the diagram engine, I have regenerated it you can find the new diagram at the old location: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/django-crm/on_boarding.md

[DjangoCRM]

Hi @ivanmilevtues, I see. Thanks.
When mentioning project modules, it would be good to insert hyperlinks to them. Currently on_boarding.md has three links and all of them lead only to your project.

[ivanmilevtues]

Do you mean the links in the diagram itself? They just link to the place where the .md is stored, however all links to source reference are pointing to the original project i.e.: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/django-crm/Analytics_Reporting.md

[DjangoCRM]

No, in the text.

[ivanmilevtues]

I think I am still a bit confuse to what link you are talking about, but if it is for the [Expand] that is linked to the other documents that we have generated and as they are in our repo they are referencing that. If this were to be in your repo all of those links would refer to you repo, as they are relative links. If I am to open a PR for your repository all the links will link to your repository, the only link which will be to us, would be the Generated with CodeBoarding badge.

[DjangoCRM]

Sorry if I wrote it unclear. This concerns SEO.
Yes, when you make PR then the links will lead to my repository but to the files generated by your program, each of which will have three links to your repository and site (Generated by, Try our Demo, FAQ). Of course, some files will contain links outside of these files but these will be links to the model code.
I think it would be useful for users and repository owners if links to module directories were added when they are mentioned in the text of files.
For example, Django CRM has the following main modules: CRM, Analytics, Tasks, Massmail
In the on_boarding.md file these modules are mentioned as: CRM Core, Analytics & Reporting, Task Management, Mass Mailer.
But without links.