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.

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

docs: add tooling section #265

Merged
merged 1 commit into from
Jan 13, 2025
Merged

Conversation

toumorokoshi
Copy link
Member

@toumorokoshi toumorokoshi commented Jan 11, 2025

Add a section that discusses the AEP tooling ecosystem. This will better improve the discoverability of the tools.

The site-generator does not currently support mermaid, but I think it'd be great if it did and we merge this in rather that switch to graphviz, which is missing highlighting of links.

Example render in my editor:

20250110_22h36m16s_grim

🍱 Types of changes

What types of changes does your code introduce to AEP? Put an x in the boxes
that apply

  • Enhancement
  • New proposal
  • Migrated from google.aip.dev
  • Chore / Quick Fix

📋 Your checklist for this pull request

Please review the AEP Style and Guidance for
contributing to this repository.

General

💝 Thank you!

Add a section that discusses the AEP tooling ecosystem. This
will better improve the discoverability of the tools.
@toumorokoshi
Copy link
Member Author

here's a PR to add mermaid support to site-generator: aep-dev/site-generator#59. We should merge that first.

Copy link
Member

@rambleraptor rambleraptor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The wording on this looks great. Do we have any control over styling? Some of the nodes are cut off in your screenshot + it would be nice to differentiate them based on color (planned, exists, external)

@toumorokoshi
Copy link
Member Author

The wording on this looks great. Do we have any control over styling? Some of the nodes are cut off in your screenshot + it would be nice to differentiate them based on color (planned, exists, external)

I think the cutoff will be fixed during the render - the screenshot was in vscode, not the new site-generator.

Re the colors I don't think we have much control, and we also should be careful about being colorblind friendly. Let's push it and then make incremental changes?

@toumorokoshi toumorokoshi merged commit 32bc991 into aep-dev:main Jan 13, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants