Skip to content

docs: simplify convert_docs.py to uni-directional conversion#564

Merged
gspencergoog merged 1 commit intogoogle:mainfrom
nan-yu:docs
Feb 13, 2026
Merged

docs: simplify convert_docs.py to uni-directional conversion#564
gspencergoog merged 1 commit intogoogle:mainfrom
nan-yu:docs

Conversation

@nan-yu
Copy link
Collaborator

@nan-yu nan-yu commented Jan 28, 2026

The bi-directional support was initially implemented to migrate existing *.md files from MkDocs admonitions to GitHub-flavored markdown.

With the migration complete, the reverse transformation is no longer needed. A uni-directional flow (GitHub -> MkDocs) is cleaner and sufficient for the build pipeline.

It also adds a README.md file to explain what the scripts do.

Description

Replace this paragraph with a description of what this PR is changing or adding, and why. Consider including before/after screenshots.

List which issues are fixed by this PR. For larger changes, raising an issue first helps reduce redundant work.

Pre-launch Checklist

If you need help, consider asking for advice on the discussion board.

Copy link
Collaborator

@zeroasterisk zeroasterisk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM — good simplification. Uni-directional is the right call since MkDocs→GitHub was never used in practice. 👍

The bi-directional support was initially implemented to migrate existing
*.md files from MkDocs admonitions to GitHub-flavored markdown.

With the migration complete, the reverse transformation is no longer
needed. A uni-directional flow (GitHub -> MkDocs) is cleaner and
sufficient for the build pipeline.

It also adds a README.md file to explain what the scripts do.
@nan-yu nan-yu enabled auto-merge (squash) February 13, 2026 19:00
@gspencergoog gspencergoog merged commit 040bcf2 into google:main Feb 13, 2026
6 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in A2UI Feb 13, 2026
lukasmoschitz pushed a commit to CopilotKit/A2UI that referenced this pull request Feb 25, 2026
)

The bi-directional support was initially implemented to migrate existing
*.md files from MkDocs admonitions to GitHub-flavored markdown.

With the migration complete, the reverse transformation is no longer
needed. A uni-directional flow (GitHub -> MkDocs) is cleaner and
sufficient for the build pipeline.

It also adds a README.md file to explain what the scripts do.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants