feat(docs): add comprehensive dependency architecture and build optimization document

- Introduced a new document detailing YAZE's dependency architecture, identifying optimization opportunities, and proposing a roadmap for reducing build times and improving maintainability.
- Included a complete dependency graph, key findings, and a detailed refactoring plan to enhance modularity and reduce circular dependencies.
- Document serves as a reference for future development and architectural decisions, aiming for 40-60% faster incremental builds.

Benefits:
- Provides a clear understanding of the current state and future direction for YAZE's architecture.
- Facilitates better decision-making for developers regarding library organization and build optimization strategies.
This commit is contained in:
scawful
2025-10-15 16:35:52 -04:00
parent 4de8f711f3
commit 3c0964d251
9 changed files with 3096 additions and 342 deletions

View File

@@ -85,6 +85,20 @@ For Doxygen integration, this index can be enhanced with:
- `@tableofcontents` for automatic TOC generation
- See individual files for `@page` and `@section` usage
### Doxygen Integration Tips
- Add a short `@mainpage` block to `docs/index.md` so generated HTML mirrors the
manual structure.
- Define high-level groups with `@defgroup` (`getting_started`, `building`,
`graphics_gui`, etc.) and attach individual docs using `@page ... @ingroup`.
- Use `@subpage`, `@section`, and `@subsection` when a document benefits from
nested navigation.
- Configure `Doxyfile` with `USE_MDFILE_AS_MAINPAGE = docs/index.md`,
`FILE_PATTERNS = *.md *.h *.cc`, and `EXTENSION_MAPPING = md=C++` to combine
Markdown and source comments.
- Keep Markdown reader-friendly—wrap Doxygen directives in comment fences (`/**`
`*/`) so they are ignored by GitHub while remaining visible to the
generator.
---
*Last updated: October 13, 2025 - Version 0.3.2*
*Last updated: October 13, 2025 - Version 0.3.2*