feat: Architecture docs #889
Conversation
Deploying devcycle-docs with
|
| Latest commit: |
77eaccf
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://5a78b1f4.devcycle-docs.pages.dev |
| Branch Preview URL: | https://puml-architecture.devcycle-docs.pages.dev |
|
@JamieSinn what's this change for? |
|
this is mostly just an arch update for docs - eventually we'll clean them up to show the full flow since the old one is out of date |
There was a problem hiding this comment.
Pull request overview
This pull request adds architecture documentation through SVG diagrams. The changes include creating a new comprehensive architecture diagram and updating existing SVG diagrams to use the correct SVG attribute values.
Key Changes:
- Added new architecture diagram (PlantUML source and generated SVG) showing the full system architecture including customer infrastructure, Cloudflare edge layer, AWS backend, and external integrations
- Fixed SVG
fillattribute values from "transparent" to "none" in existing diagrams (server-sdk-initialization, event-manager, config-manager) - Updated GitHub Actions workflow to use a pinned commit SHA instead of
@mainbranch reference
Reviewed changes
Copilot reviewed 2 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| static/diagrams/server-sdk-initialization.svg | Fixed SVG fill attribute from "transparent" to "none" for proper rendering |
| static/diagrams/event-manager.svg | Fixed SVG fill attribute from "transparent" to "none" for proper rendering |
| static/diagrams/config-manager.svg | Fixed SVG fill attribute from "transparent" to "none" for proper rendering |
| static/diagrams/architecture.svg | Added new comprehensive architecture diagram showing system components and integrations |
| diagrams/architecture.puml | Added PlantUML source file defining the architecture diagram with proper styling and component definitions |
| .github/workflows/diagrams.yml | Updated PlantUML GitHub Action to use pinned commit SHA for improved reproducibility |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| run: | | ||
| echo "::set-output name=files::$(git diff --name-only HEAD^ HEAD | grep .puml | xargs)" | ||
| - name: Generate SVG Diagrams |
There was a problem hiding this comment.
The GitHub Action reference has been pinned to a specific commit SHA (2e381afb2bae7e169b76bfb068e8d8b2089106ee) instead of using @main. While this improves reproducibility, it's important to verify that this commit hash exists and is from a trusted source. Consider documenting why this specific commit was chosen or periodically reviewing and updating to newer versions for security patches and bug fixes.
| - name: Generate SVG Diagrams | |
| - name: Generate SVG Diagrams | |
| # Pinned to holowinski/plantuml-github-action@2e381afb2bae7e169b76bfb068e8d8b2089106ee for reproducibility and security. | |
| # Verified commit from trusted source as of 2024-06. Review and update periodically for security patches and bug fixes. |
No description provided.