Add architecture diagrams and replace ASCII flows with images

[mohit-nagaraj]

Summary

• Added 6 Excalidraw-generated architecture diagrams (workflow API flow, SSE status stream, terminal exec session, resource watch pipeline, workflow versioning, node data flow)
• Replaced ASCII code blocks in data-flow.md and ui-frontend.md with proper image references
• Added new subsections under Real-Time Resource Monitoring for pipeline, SSE stream, and terminal exec diagrams
• Removed default Starlight placeholder files (guides/example.md, reference/example.md)

Test plan

• Verify all 6 images render correctly in the docs site
• Check no broken image paths in data-flow.md and ui-frontend.md
• Confirm placeholder example docs are gone from the sidebar

[gemini-code-assist]

Summary of Changes

Hello @mohit-nagaraj, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the documentation by integrating new, visually rich architecture diagrams and replacing outdated ASCII art with modern image references. The changes aim to improve the overall readability and understanding of complex system flows, making the documentation more accessible and informative for users and developers alike.

Highlights

• New Architecture Diagrams: Added six new Excalidraw-generated architecture diagrams covering workflow API flow, SSE status stream, terminal exec session, resource watch pipeline, workflow versioning, and node data flow.
• Documentation Clarity: Replaced existing ASCII code blocks in data-flow.md and ui-frontend.md with proper image references for improved visual clarity.
• Documentation Structure: Introduced new subsections under 'Real-Time Resource Monitoring' for pipeline, SSE stream, and terminal exec diagrams to better organize content.
• Cleanup: Removed default Starlight placeholder files (guides/example.md, reference/example.md) to streamline the documentation.

Changelog

• src/content/docs/architecture/data-flow.md
  • Added 'Workflow API Flow' diagram.
  • Introduced new subsections for 'Resource Watch Pipeline', 'SSE Status Stream', and 'Terminal Exec Session' diagrams.
  • Replaced ASCII block describing version control flow with 'Workflow Versioning' image.
• src/content/docs/architecture/ui-frontend.md
  • Replaced ASCII block describing node data flow with 'Node Data Flow' image.
• src/content/docs/guides/example.md
  • Deleted placeholder guide file.
• src/content/docs/reference/example.md
  • Deleted placeholder reference file.

Activity

• Verify all 6 new images render correctly in the docs site.
• Check for no broken image paths in data-flow.md and ui-frontend.md.
• Confirm placeholder example documentation files are no longer present in the sidebar.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request improves the documentation by replacing several ASCII art diagrams with clearer, Excalidraw-generated images. It also adds new architecture diagrams to provide more detail on data flows for various features like real-time monitoring. Additionally, it cleans up the project by removing placeholder documentation files. My review focuses on improving the accessibility of the new images by suggesting more descriptive alt text. Overall, these are great changes that enhance the quality of the documentation.

[gemini-code-assist]

For better accessibility, the alt text for this image should be more descriptive. Currently, it just says "Workflow Versioning". A good alt text should briefly describe the image's content for screen readers. This suggestion also applies to the other new images in this file.

For example, the previous ASCII diagram described the flow of saving, comparing, and restoring versions. The alt text could reflect that.

Suggested change

	
	

[gemini-code-assist]

To improve accessibility, the image's alt text should be more descriptive. Instead of just "Node Data Flow", it could summarize the flow it represents. The previous ASCII diagram showed the sequence from a user edit to a canvas re-render.

Suggested change