Skip to content

Improvements for extracting @luau documentation#1386

Open
EternalAbby wants to merge 7 commits intoJohnnyMorganz:mainfrom
EternalAbby:main
Open

Improvements for extracting @luau documentation#1386
EternalAbby wants to merge 7 commits intoJohnnyMorganz:mainfrom
EternalAbby:main

Conversation

@EternalAbby
Copy link

@EternalAbby EternalAbby commented Feb 28, 2026

Since it's harder to correctly determine where the library functions are on the Luau site; they are put into block quotes, this pull request mainly adds changes to the URL's fragment so that it directs to the library's section.

  • Changed links from directing to the roblox docs site to directing to the luau docs.
  • Corrected vector library having @roblox prefix instead of @luau in the luau generated json.
  • Import only the necessary methods.
  • Pretty-print the JSON file.

This pull request is done to add ideas from #1357.

Since it's harder to correctly determine where the functions are on the Luau site; they are put into block quotes, this change only changes the URL's fragment so that it directs to the library's section.

- Changed links directing to the roblox docs site to the luau docs.
- Import only the necessary methods.
- Pretty-print the JSON file.
- Explicitly close files after using them.
- Moved code for URL change.
- Improved code comments.
- Changed indent to 2 spaces to match `en-us.json`
@EternalAbby
Copy link
Author

I'm not sure if I need to do the commits with the luau-en-us.json file generated or not.

also, ignore the first commit being unverified, forgot to add signing key

@JohnnyMorganz
Copy link
Owner

Unfortunately I can't accept the changes to scripts/api-docs/en-us.json as that comes direct from upstream source. But we can look at the changes to the python generator and the generated luau-en-us.json file

EternalAbby and others added 2 commits March 7, 2026 11:27
Co-authored-by: JohnnyMorganz <johnnymorganz@outlook.com>
Co-authored-by: JohnnyMorganz <johnnymorganz@outlook.com>
@EternalAbby
Copy link
Author

first time using pull requests so this is quite jank, sorry about that

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