Skip to content

BED-8065: Add support to generate plain-markdown pages for other documentation engines #9

Draft
d3vzer0 wants to merge 22 commits intofeature/0.2.0from
fix/devdocs
Draft

BED-8065: Add support to generate plain-markdown pages for other documentation engines #9
d3vzer0 wants to merge 22 commits intofeature/0.2.0from
fix/devdocs

Conversation

@d3vzer0
Copy link
Copy Markdown
Contributor

@d3vzer0 d3vzer0 commented May 8, 2026

Description

The current docs generation command relies on mkdocstrings' specific functions to render pages. For example, to render the docstrings you would simply refer to the Python (data)class inside a markdown file like so:

::: openhound_okta.source.source
    options:
        show_source_link: true
        show_root_heading: true
        heading_level: 3

In order to add support for mintlify (and other doc frameworks), this PR adds a new method to generate plain markdown files for all node and edge specific pages. This allows us to keep all the detailed docs in this repo, but at the same time generate node/edge descriptions that can be synced with the official bloodhound.specterops.io website.

Motivation and Context

We want to keep the documentation about nodes/edges for each collector up to date on the bloodhound.specterops.io website.

How Has This Been Tested?

  • The test_docs_pipeline.py test generates collector docs and verifies if node and edge pages for the dummy collector are rendered in markdown correctly

Screenshots (if appropriate):

Types of changes

  • Chore (a change that does not modify the application functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

@d3vzer0 d3vzer0 changed the title BED-8065: Add custom dataclass parser to generate generic markdown templates for other documentation engines BED-8065: Add support to generate plain-markdown pages for other documentation engines May 8, 2026
@d3vzer0 d3vzer0 added the enhancement New feature or request label May 8, 2026
@d3vzer0 d3vzer0 marked this pull request as draft May 8, 2026 21:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant