Skip to content
New issue

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

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

Already on GitHub? # to your account

[Documentation] Add some architectural views in the project #5643

Open
Madunguin opened this issue Feb 25, 2025 · 4 comments
Open

[Documentation] Add some architectural views in the project #5643

Madunguin opened this issue Feb 25, 2025 · 4 comments
Labels
enhancement new features, suggestions, etc.

Comments

@Madunguin
Copy link

**Is your feature request related to a problem? Please describe.
My team and I believe that adding some architectural views will help new developers collaborate on the project or use the program more easily.

Describe the solution you'd like
We think that adding then in the Read Me will help then.

Additional context
We are a group of students and in our project we had to investigate what is eXist-db, and we think really think that with these diagrams more people will understand how eXist works .

@Madunguin Madunguin added the enhancement new features, suggestions, etc. label Feb 25, 2025
@adamretter
Copy link
Contributor

Sounds good. It might be better to place them in a separate Markdown file and like them from README.md in the same way that https://github.com/eXist-db/exist/blob/develop/CONTRIBUTING.md is

@Madunguin
Copy link
Author

Thanks, We are working on the Markdown.

@Madunguin
Copy link
Author

We have already created the Markdown file. What do you want us to do with it?
Do you want me to send it to you in some way so you can review it and see if it is suitable to be added as extra documentation for the project?

@joewiz
Copy link
Member

joewiz commented Mar 3, 2025

@Madunguin Great! You are welcome to submit a PR - or post the content into this issue as your next reply, for discussion about the best destination for the content.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
enhancement new features, suggestions, etc.
Projects
None yet
Development

No branches or pull requests

3 participants