feat: adding script for generating Mardown docs (also adding macOS Docker support)#212
Open
feat: adding script for generating Mardown docs (also adding macOS Docker support)#212
Conversation
zfields
force-pushed
the
tj-markdown-docs
branch
from
208da65 to
b258468
Compare
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
1 participant
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.
This PR adds a new script that can be used to generate Markdown docs with our existing Doxygen setup. To test this, I had to make some changes to our Docker config to get it running on my Mac.
Claude wrote 90%+ of this PR, so approach it with skepticism, but I did thoroughly test the outputted Markdown to ensure it was valid and what we need.
You can test by running
scripts/build_docs_markdown.shand viewing the output inbuild/docs/markdown.