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

Documenting project structure, state management, and event hierarchy #44

Open
ondrej33 opened this issue Jul 12, 2024 · 0 comments
Open
Assignees

Comments

@ondrej33
Copy link
Member

As the project structure gets more and more complex, we should start making some kind of external project documentation (apart from existing code documentation). Apart from the project structure, this should include a high-level description of the internal class hierarchy used to track the state of the sketch editor (and the analysis in future). This could initially be just some readme, but it should include UML diagrams and a more systematic description in future.

Similarly to that, we should make a list of events (together with their hierarchy) and their description. This will help in the task of refactoring them, too. For each event, we should note at least the following:

  • its name and purpose
  • components of the state it can modify
  • its corresponding reverse events or "opposite-direction" events
  • events it is related to (in case of more complex event relationships)
@ondrej33 ondrej33 self-assigned this Jul 12, 2024
@ondrej33 ondrej33 changed the title Documenting application state structure and event hierarchy Documenting project structure, state management, and event hierarchy Jul 12, 2024
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

No branches or pull requests

1 participant