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.

Sign up for GitHub

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

Jump to bottom

Update Mithril architecture documentation #1499

Merged
merged 6 commits into from
Feb 14, 2024
Merged

Update Mithril architecture documentation #1499

merged 6 commits into from
Feb 14, 2024

Conversation

jpraynaud
Copy link
Member

@jpraynaud jpraynaud commented Feb 12, 2024 •
edited
Loading

Content

This PR includes:

  • A C4 diagram for the Mithril network architecture
  • And the update of the architecture page of the documentation

Screenshot from 2024-02-12 18-09-09

Pre-submit checklist

  • Branch
    • Commit sequence broadly makes sense
    • Key commits have useful messages
  • PR
    • No clippy warnings in the CI
    • Self-reviewed the diff
    • Useful pull request description
    • Reviewer requested
  • Documentation
    • Update documentation website (if relevant)

Issue(s)

Closes #1488

@jpraynaud jpraynaud self-assigned this Feb 12, 2024
@github-actions GitHub Actions
Copy link

github-actions bot commented Feb 12, 2024 •
edited
Loading

Test Results

  3 files  ±0   37 suites  ±0   9m 39s ⏱️ + 1m 14s
829 tests ±0  829 ✅ ±0  0 💤 ±0  0 ❌ ±0 
914 runs  ±0  914 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 673d555. ± Comparison against base commit 3a1992f.

♻️ This comment has been updated with latest results.

@jpraynaud jpraynaud force-pushed the jpraynaud/1488-update-architecture-doc branch from fe13960 to 76307a9 Compare February 13, 2024 08:25
@jpraynaud jpraynaud marked this pull request as ready for review February 13, 2024 08:25
olgahryniuk
olgahryniuk reviewed Feb 13, 2024
View reviewed changes
docs/website/root/mithril/mithril-network/architecture-c4.puml Outdated Show resolved Hide resolved
docs/website/root/mithril/mithril-network/architecture-c4.puml Outdated Show resolved Hide resolved
docs/website/root/mithril/mithril-network/architecture-c4.puml Outdated Show resolved Hide resolved
docs/website/root/mithril/mithril-network/architecture-c4.puml Outdated Show resolved Hide resolved
docs/website/root/mithril/mithril-network/architecture-c4.puml Outdated Show resolved Hide resolved
docs/website/root/mithril/mithril-network/architecture-c4.puml Outdated Show resolved Hide resolved
docs/website/root/mithril/mithril-network/architecture-c4.puml Outdated Show resolved Hide resolved
docs/website/root/mithril/mithril-network/architecture-c4.puml Outdated Show resolved Hide resolved
docs/website/root/mithril/mithril-network/architecture.md Outdated Show resolved Hide resolved
docs/website/root/mithril/mithril-network/architecture.md Outdated Show resolved Hide resolved
@jpraynaud jpraynaud force-pushed the jpraynaud/1488-update-architecture-doc branch from 93f2a6b to 673d555 Compare February 13, 2024 16:17
@jpraynaud jpraynaud merged commit 939e16e into main Feb 14, 2024
40 checks passed
@jpraynaud jpraynaud deleted the jpraynaud/1488-update-architecture-doc branch February 14, 2024 08:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@olgahryniuk olgahryniuk olgahryniuk left review comments

@Alenar Alenar Alenar approved these changes

@dlachaume dlachaume dlachaume approved these changes

@sfauvel sfauvel Awaiting requested review from sfauvel

Assignees

@jpraynaud jpraynaud

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update Mithril network architecture documentation
4 participants
@jpraynaud @Alenar @olgahryniuk @dlachaume