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

Add architecture examples #255

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

noahbald
Copy link

Closes #250

Adds examples and resources for Architecture.md files

@Robson
Copy link
Collaborator

Robson commented May 4, 2024

Thank you for this - looks great! I don't seem to have the permissions to create a pull request, so would you mind changing the list to be this:

- [esbuild](https://github.com/evanw/esbuild/blob/main/docs/architecture.md) - Great use of graphics for visualisations and project structure. Includes a list of important principles for the project.
- [Flutter Engine](https://github.com/flutter/flutter/wiki/The-Engine-architecture) - Good use of high level diagrams to show the stack and its parts. Describes the main processes. Describes platform invariants.
- [GitLab](https://gitlab.com/gitlab-org/charts/gitlab/-/tree/master/doc/architecture) - Calls out design decisions.
- [Linux cryptography](https://github.com/torvalds/linux/blob/master/Documentation/crypto/architecture.rst) - Calls out different types of components, provides searchable areas, calls out invariants of different components, and describes structure with diagrams.
- [Neovim](https://github.com/neovim/neovim/blob/master/src/nvim/README.md) - Describes the main processes/lifecycle.
- [Next.js](https://github.com/vercel/next.js/blob/canary/docs/04-architecture/index.mdx) - Breaks architecture into separate files, calls out important dependencies.
- [Oh My Zsh](https://github.com/ohmyzsh/ohmyzsh/wiki/Design) - Describes the initialization process, calls out environment requirements.
- [Redis](https://github.com/redis/redis/blob/unstable/README.md) - Good source code map. Overviews of key files. Good use of documentation comments in-code rather than inline comments.
- [rust-analyser](https://github.com/rust-lang/rust/blob/master/src/tools/rust-analyzer/docs/dev/architecture.md) - Good diagrams, describes entry points and source organisation, discusses architecture considerations.
- [Tauri](https://github.com/tauri-apps/tauri/blob/dev/ARCHITECTURE.md) - Well made source code map, discusses architecture considerations, calls out important dependencies.
- [VS Code](https://github.com/microsoft/vscode/wiki/Source-Code-Organization) - Good use of high-level diagrams. Describes source organisation.

That is reordered alphabetically and with some minor punctuation/name fixes.

Could we have a look at the Next.js entry? I think that must be linking to the wrong file, or the file has changed, or some other issue.

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.

Include quality ARCHITECTURE and CONTRIBUTING documentation
2 participants