Skip to content

Conversation

@deven367
Copy link
Collaborator

@deven367 deven367 commented Oct 20, 2025

This PR migrates from lazydocs to mkdocstrings

  • update Makefile
  • update workflow
  • add docs
  • add parser

cursor[bot]

This comment was marked as outdated.

@codspeed-hq
Copy link

codspeed-hq bot commented Oct 20, 2025

CodSpeed Performance Report

Merging #1060 will not alter performance

Comparing lazydocs-to-mkdocstrings (22b578a) with main (54c9740)

Summary

✅ 6 untouched

for file in Path(input_dir).rglob("*.md"):
output_file = file.with_suffix(".mdx").name
print(f"Processing {file} -> {output_file}")
parser.process_file(str(file), str(Path(input_dir) / "mintlify" / output_file))
Copy link

Choose a reason for hiding this comment

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

Bug: Missing Directory Causes File Writing Error

The process_files function writes generated MDX files to a mintlify subdirectory within the input_dir. This directory isn't explicitly created, which can cause a FileNotFoundError when the script attempts to write files.

Fix in Cursor Fix in Web

(output_path / "index.mdx").write_text(readme_text)
readme_text = Path("README.md").read_text()
readme_text = header + readme_text
(output_path / "index.mdx").write_text(readme_text)
Copy link

Choose a reason for hiding this comment

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

Bug: Inconsistent File Path Handling

The copy_readme function always writes index.mdx to a hardcoded path, while process_files uses a path derived from the input_dir argument. This inconsistency can lead to index.mdx being placed in a different output directory than other processed files when a custom input directory is used, potentially breaking the documentation build.

Fix in Cursor Fix in Web

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants