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.

Sign up for GitHub

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

Jump to bottom

Add technical documentation #1

Open
haruspeks opened this issue Jul 30, 2024 · 1 comment
Open

Add technical documentation #1

haruspeks opened this issue Jul 30, 2024 · 1 comment
Assignees
@haruspeks
Labels
documentation Improvements or additions to documentation

Comments

@haruspeks
Copy link
Collaborator

One of Avoc's goals is to be easily extendable, making the addition of new features or services a handy endeavor. Technical documentation should be added to explain the code architecture and how to add new modules.
@haruspeks haruspeks added the documentation Improvements or additions to documentation label Jul 30, 2024
@haruspeks haruspeks self-assigned this Jul 30, 2024
@haruspeks
Copy link
Collaborator Author

haruspeks commented Aug 6, 2024 •
edited
Loading

Writing down some notes for the technical documentation.

Things to focus on:

  • Why this app exists: purposes, limitations, other uses
  • Architecture of the app (modules and RequireJS)
  • How to add a new map
  • How to add a new service
  • How to add a new generic module
  • How to expose data to the UI via Alpine

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@haruspeks haruspeks

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@haruspeks