Skip to content

Fix two types of documentation #15

Open
Open
Fix two types of documentation#15

Description

@GrosQuildu
GrosQuildu
opened on Nov 15, 2024

We have qlhelp and md files as documentation for rules. There should only be the qlhelp type. Documentation in markdown is for additional, not rule-specific information.

Or I guess so, will need to read GitHub docs to find proper way of documenting rules.

Activity

  1. evandowning commented on Apr 17, 2026

    @evandowning
    evandowning
    on Apr 17, 2026
    Contributor

    Did #40 resolve this?

  2. GrosQuildu commented on Apr 18, 2026

    @GrosQuildu
    GrosQuildu
    on Apr 18, 2026
    ContributorAuthor

    Probably. Have you check what documentation format is recommended (markdown vs qlhelp)?
    Likely we need only one of these

  3. evandowning commented on Apr 20, 2026

    @evandowning
    evandowning
    on Apr 20, 2026
    Contributor

    I think qlhelp is recommended. This generates markdown from qlhelp files so they're human-readable, but it can also generate sarif files.

    Sources

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions