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

Apply linting rules to Alloy Faro component docs #2412

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

Apply linting rules to Alloy Faro component docs #2412

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

Comments

@clayton-cornell
Copy link
Contributor

The Alloy component documentation needs general cleanup, including things like:

  • Pretty print tables
  • Sort table rows alphabetically - required first, then all optional
  • Sort blocks alphabetically
  • Fix block heading hierarchy
  • Add badge for Required blocks
  • Remove block from heading text
  • Remove extra spaces and extra CR/LFs
  • Tidy markdown - spaces around lists, indentation, etc.
@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
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant