Conversation
…g, should quality suffer
…ray/auto_publish_main_mkdocs
reyang
approved these changes
Aug 21, 2025
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.
This pull request primarily removes dependencies on the
CDocsMarkdownCommentRenderfilter and its related environment setup from the documentation build and conversion scripts. It also updates a documentation link for clarity.This filter is only used for the {DOCX, PDF, ePUB} file generation.
I do think this filter is useful, but it's too fragile / complicated and upon reflection shouldn't be in the main branch.
I'd like to add it back in the future, but only when it's less fragile and complicated.
Below are the most important changes grouped by theme:
Removal of CDocsMarkdownCommentRender Filter and Environment Setup:
CDocsMarkdownCommentRenderfrom thetools/PreCheckinUpdate.shscript, including environment variable setup, binary checks, and filter usage in the pandoc command. This simplifies the script and removes the need to clone or build the CDocs repository. [1] [2]CDocsMarkdownCommentRenderto thePATHin thetools/buildAsBook/Dockerfile.pandocDockerfile, further decoupling the build process from the CDocs toolchain.tools/buildAsBook/bind.pyscript to remove the--filter CDocsMarkdownCommentRenderflag from the pandoc command, ensuring markdown conversion no longer relies on this external filter.General Script and Documentation Maintenance:
tools/PreCheckinUpdate.sh, streamlining the script and reducing complexity for local and CI builds.docs/docs/Rude_Q_and_A.mdto point to the correct Actions overview document, improving documentation accuracy.Fixes #Design discussion issue #
Changes
Please provide a brief description of the changes here.
Merge requirement checklist