Skip to content

Initial development & contribution documentation #934

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

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

KaiKorla
Copy link
Contributor

@KaiKorla KaiKorla commented Apr 17, 2025

Starting a development & contribution documentation. Let me know if i missed any topic.

Feedback welcome!

TODO

  • Discussing if need a "Be nice" policy
  • Define what "fast" means in the context of Halloy
  • Fill open topics (TODO) with content

@KaiKorla KaiKorla force-pushed the feat/book-developer-guide branch from 6f989d0 to 4f3ed37 Compare April 18, 2025 18:50
@KaiKorla
Copy link
Contributor Author

Would it be helpful to have an architecture diagram? For example

image

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Over two and a half thousand lines of javascript? Could you not find something much lighter?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, Mermaid.js is a well known tool. Idk if there is something else. If we don't need the architecture diagram, i can remove it.

@KaiKorla KaiKorla force-pushed the feat/book-developer-guide branch from 1174d4b to cf32779 Compare April 19, 2025 18:51
@KaiKorla
Copy link
Contributor Author

KaiKorla commented Apr 21, 2025

@andymandias @casperstorm @tarkah

Some open topics, but IMO ready for discussing and review. tyvm.

@KaiKorla KaiKorla marked this pull request as ready for review April 21, 2025 16:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants