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

Revise the information flow in the Alloy Component topics #2422

Open
clayton-cornell opened this issue Jan 15, 2025 · 0 comments
Open

Revise the information flow in the Alloy Component topics #2422

clayton-cornell opened this issue Jan 15, 2025 · 0 comments
Assignees
@clayton-cornell

Comments

@clayton-cornell
Copy link
Contributor

The Alloy component documentation is OK as-is, but the information is at times confusing if you're not already very familiar with the inner workings of Alloy

There are several things that need attention:

  • Hierarchy: Some blocks are nested under parent blocks. This is not well presented. One solution could be something similar to the tree view (Linux tree command output)
  • Table formats with required listed first?
  • Clear notation on required blocks - a badge?
@clayton-cornell clayton-cornell self-assigned this Jan 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@clayton-cornell clayton-cornell

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@clayton-cornell