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

Clean up VQL reference #3758

Merged
merged 4 commits into from
Sep 15, 2024
Merged

Conversation

predictiple
Copy link
Contributor

@predictiple predictiple commented Sep 14, 2024

  • Reduced inline accessor descriptions to basic descriptions since the full descriptions, including examples, are now represented in vql.yaml (which I double-checked).
  • Standardized the markdown headings in vql.yaml descriptions so that they will look consistent on the documentation site.
  • Fixed some minor issues in vql.yaml descriptions.
  • Slightly changed formatting for accessors in vql list command so that they render prettier when piped through glow.
    Screenshot from 2024-09-14 18-29-44
    Maybe in future we could do direct markdown rendering using Charm's Glamour package?

@scudette scudette merged commit e09a091 into Velocidex:master Sep 15, 2024
3 checks passed
@predictiple predictiple deleted the normalize-vql-examples branch September 15, 2024 13:29
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.

2 participants