awesome-readme icon indicating copy to clipboard operation
awesome-readme copied to clipboard

Add architecture examples

Open noahbald opened this issue 10 months ago • 1 comments

Closes #250

Adds examples and resources for Architecture.md files

noahbald avatar Apr 21 '24 02:04 noahbald

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.

Robson avatar May 04 '24 12:05 Robson

I seem to be able to edit now, so I've sorted the entries, fixed the names, removed the Next.js entry, and updated the Flutter Engine link to the new location.

Robson avatar Jun 15 '24 14:06 Robson