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

[Docs] "How to read a MeshMap Design" #265

Open
leecalcote opened this issue Jun 3, 2024 · 1 comment
Open

[Docs] "How to read a MeshMap Design" #265

leecalcote opened this issue Jun 3, 2024 · 1 comment
Labels
area/docs Improvements or additions to documentation framework/hugo help wanted Extra attention is needed issue/willfix This issue will be worked on language/markdown

Comments

@leecalcote
Copy link
Member

Current State

Users are in need of a guide to understanding the symbols and relationships that are visually conveyed inside of a design. In some respects, a legend and another a guide with examples.

Desired State

  1. A new "Reading and Understanding Design" docs page.
  2. Snapshots (like this one) should have a comment included that points to this "How to read a MeshMap Design" docs page.

Contributor Guides and Resources
@leecalcote leecalcote added area/docs Improvements or additions to documentation help wanted Extra attention is needed issue/willfix This issue will be worked on language/markdown framework/hugo labels Jun 3, 2024
@Alero-Awani
Copy link
Contributor

Hello @leecalcote, I'll start working on this now!

@leecalcote leecalcote mentioned this issue Jun 27, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/docs Improvements or additions to documentation framework/hugo help wanted Extra attention is needed issue/willfix This issue will be worked on language/markdown
Milestone
No milestone
Development

No branches or pull requests
2 participants
@leecalcote @Alero-Awani