Skip to content

Conversation

@sayalaruano
Copy link
Collaborator

Summary

Add script to split readme and organize documentation

List of changes proposed in this PR (pull-request)

  • Add script to split readme and organize documentation
  • Update conf.py to add the split_readme.py script
  • Update index.md

@sayalaruano
Copy link
Collaborator Author

I just checked the updated documentation, but the admonitions are not working. I do not remember modifying anything else for the VueGen docs. Maybe you fixed something to make the VueGen one work @enryH?

@sayalaruano sayalaruano requested a review from enryH August 21, 2025 08:22
sayalaruano and others added 2 commits August 21, 2025 13:38
@enryH
Copy link
Collaborator

enryH commented Aug 21, 2025

I just checked the updated documentation, but the admonitions are not working. I do not remember modifying anything else for the VueGen docs. Maybe you fixed something to make the VueGen one work @enryH?

You needed to activate for the myst_nb extension the option colon_fence to activate their admonitions.

Copy link
Collaborator

@enryH enryH left a comment

Choose a reason for hiding this comment

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

Hey. Looks good. Only the white space above the overview in the left sidebar is uncommon. maybe the deletion of the caption on the include statement will work. Include literally just copies content into the index file.

@sayalaruano sayalaruano merged commit c707527 into main Aug 21, 2025
9 checks passed
@sayalaruano sayalaruano deleted the split-readme-docs branch August 21, 2025 13:24
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.

3 participants