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

doc: improve core rules introduction #3100

Merged
merged 1 commit into from
Apr 1, 2022

Conversation

sluongng
Copy link
Contributor

Added a visualization for sample Bazel Build Graph when using rules_go
core rules to help new users better understand the relationship between
them.

The graphic was created with Excalidraw and exported to SVG for display.

What type of PR is this?

Uncomment one line below and remove others.

Bug fix
Feature
Documentation
Other

What does this PR do? Why is it needed?

Improve documentation for new users of rules_go

Which issues(s) does this PR fix?

Other notes for review

I am open for feedbacks regarding how the graphic should look.
I have included an buildgraph.excalidraw file so that anyone can open this up in https://excalidraw.com/ and edit

@sluongng
Copy link
Contributor Author

A rendered version of the graph could be viewed here https://github.com/sluongng/rules_go/blob/sluongng/pretty-graph/docs/go/core/rules.md#introduction

Added a visualization for sample Bazel Build Graph when using rules_go
core rules to help new users better understand the relationship between
them.

The graphic was created with Excalidraw and exported to SVG for display.
Copy link
Contributor

@linzhp linzhp left a comment

Choose a reason for hiding this comment

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

That looks pretty. Thanks

@linzhp linzhp merged commit 466437c into bazelbuild:master Apr 1, 2022
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.

None yet

2 participants