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

Create a separate Architecture document #30

Open
evangineer opened this issue Nov 14, 2024 · 3 comments
Open

Create a separate Architecture document #30

evangineer opened this issue Nov 14, 2024 · 3 comments

Comments

@evangineer
Copy link

evangineer commented Nov 14, 2024 •
edited
Loading

This is a good model that I would consider emulating.

https://github.com/outline/outline/blob/main/docs/ARCHITECTURE.md

Could be supplemented with Architecture Decision Records with Rationale, Alternatives and Usage sections.
@evangineer
Copy link
Author

evangineer commented Nov 15, 2024 •
edited
Loading

I've actually started working on this.

It forces me to start familarizing myself with the code.

Will make a pull request when I have a first draft.

@RobertAtNineMinds
Copy link
Contributor

Thank you!

@RobertAtNineMinds
Copy link
Contributor

I added a rough overview document here:

https://github.com/Nine-Minds/alga-psa/blob/main/docs/overview.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@evangineer @RobertAtNineMinds