google / google/lyra

Document library architecture

Open
#51 2 comments 0 reactions 0 assignees View on GitHub
documentation good first issue help wanted
Dominant language
C++
Stars
4k
Forks
368
PR merge metrics
No merged PRs in 30d

Description

It'd be nice if the lib had some docs (maybe in a form of a graph), describing its architecture at different levels of detail, including:

* components present within the lib
* their functionality, semantics and interfaces (not class interfaces, but what it consumes and produces)
* components' interactions to other components and flows of data between them
* possibilities to replace that component with something else, both other implementations of the same thing and implementations of completely different thing that may have similar effect
* why each component is needed and if it is avoidable and impact of it being skipped or replaced

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.