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
Draft
BED-8065: Add support to generate plain-markdown pages for other documentation engines #9d3vzer0 wants to merge 22 commits intofeature/0.2.0from
d3vzer0 wants to merge 22 commits intofeature/0.2.0from
Conversation
… to specify template, defaults to mkdocs
…n automated docs
…or as a reference. Each repo will contain their own collector-specific documentation.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
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?
Screenshots (if appropriate):
Types of changes