Skip to content

Commit

Permalink
docs: [MTG-1221] Add comprehensive architecture documentation (#420)
Browse files Browse the repository at this point in the history
* docs: comprehensive documentation update

- Add detailed system architecture documentation with component descriptions and data flow

- Clean up and modernize README with clearer structure and links to architecture docs

- Update CONTRIBUTING guidelines with detailed setup instructions and best practices

The changes provide a complete overview of the system's architecture, components, data flow, and database structure, while making the documentation more accessible and maintainable.

* docs: Update README.md

Co-authored-by: Oleksandr Mykhailenko <[email protected]>

* chore: update docs and remove deprecated clippy config

- docs(CONTRIBUTING.md):
    - Remove explicit Rust version (using rust-toolchain.toml).
    - Add note about bootstrapping Postgres for local integration tests.
    - Clarify feature branch naming convention (ticket number optional).
    - Remove redundant unit test command from CI section.
    - Add merge strategy (squash merging).
    - Improve clarity and formatting.
- docs(architecture.md):
    - Remove specific class dependencies, listing high-level dependencies instead.
    - Clarify BigTable's role as a data origin for the Slots DB.
    - Remove `explorer_client` (uncommitted code).
    - Correct formatting and improve wording.
- chore: Remove deprecated and faulty .clippy.toml.

* docs: refine release process

* docs: fix api type

---------

Co-authored-by: Oleksandr Mykhailenko <[email protected]>
  • Loading branch information
StanChe and armyhaylenko authored Feb 19, 2025
1 parent 3c2bda8 commit d68d0ac
Show file tree
Hide file tree
Showing 3 changed files with 516 additions and 170 deletions.
Loading

0 comments on commit d68d0ac

Please sign in to comment.