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] Working with Components #354

Open
Alero-Awani opened this issue Aug 20, 2024 · 2 comments
Open

[Docs] Working with Components #354

Alero-Awani opened this issue Aug 20, 2024 · 2 comments
Assignees
Labels
area/docs Improvements or additions to documentation framework/hugo language/markdown

Comments

@Alero-Awani
Copy link
Contributor

Alero-Awani commented Aug 20, 2024

Current State

In the MeshMap docs

"Working with Components" appears twice:

  1. Under Getting Started With Designs and
  2. In the Main Meshmap table of content

Desired State

There should only be one occurrence of the "Working with Components" document in the MeshMap docs, and it should be structured clearly to avoid confusing users. The content from both existing pages could be merged and expanded to accurately explain what components are and what they can do within MeshMap.

This new document should factor in:

  1. Configuring components.
  2. Using the radial context menu to lock, style, duplicate, and delete components.
  3. Annotations

More research should be done on the Use of components within Meshmap.


Contributor Guide and Resources

@Alero-Awani Alero-Awani added area/docs Improvements or additions to documentation language/markdown framework/hugo labels Aug 20, 2024
@sparshagl
Copy link
Contributor

@Alero-Awani I can get started with merging the contents, followed by additional points.

Where should we put the final doc?

@Alero-Awani
Copy link
Contributor Author

For now it will be under "Getting Started with Designs"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Improvements or additions to documentation framework/hugo language/markdown
Development

No branches or pull requests

2 participants