Migrate documentation from custom tool to typedoc #158
Conversation
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
adamziel
added
[Type] Documentation
adamziel
force-pushed
the
api-doc-readability
branch
from
405ef10 to
c543b16
Compare
adamziel
added a commit
that referenced
this pull request
May 30, 2025
## Motivation for the change, related issues Ensures URLs with data URL-based Blueprints, such as ``` https://playground.wordpress.net?blueprint-url=data%3Aapplication%2Fjson%3Bbase64%2CeyJsYW5kaW5nUGFnZSI... ``` continue to work. They stopped working in Automattic/wordpress-playground-private#75 due to FetchFilesystem class. It assumed a non-data URL and constructed a `new URL('./', baseUrl)` object in its constructor – which failed when `baseUrl` was a data URL. See Automattic/wordpress-playground-private#157 for more details ## Testing Instructions (or ideally a Blueprint) Confirm E2E tests pass – this PR ships a new one Try [this data URL Blueprint](http://127.0.0.1:5400/website-server/?blueprint-url=data%3Aapplication%2Fjson%3Bbase64%2CeyJsYW5kaW5nUGFnZSI6Ii9mcmllbmRzLz9yZWZyZXNoJndlbGNvbWUiLCJmZWF0dXJlcyI6eyJuZXR3b3JraW5nIjp0cnVlfSwic3RlcHMiOlt7InN0ZXAiOiJta2RpciIsInBhdGgiOiJ3b3JkcHJlc3Mvd3AtY29udGVudC9tdS1wbHVnaW5zIn0seyJzdGVwIjoid3JpdGVGaWxlIiwicGF0aCI6IndvcmRwcmVzcy93cC1jb250ZW50L211LXBsdWdpbnMvYWRkRmlsdGVyLTEucGhwIiwiZGF0YSI6Ijw%2FcGhwIGFkZF9hY3Rpb24oICdyZXF1ZXN0cy1yZXF1ZXN0cy5iZWZvcmVfcmVxdWVzdCcsIGZ1bmN0aW9uKCAmJHVybCApIHtcbiR1cmwgPSAnaHR0cHM6Ly9wbGF5Z3JvdW5kLndvcmRwcmVzcy5uZXQvY29ycy1wcm94eS5waHA%2FJyAuICR1cmw7XG59ICk7In0seyJzdGVwIjoic2V0U2l0ZU9wdGlvbnMiLCJvcHRpb25zIjp7InBlcm1hbGlua19zdHJ1Y3R1cmUiOiIvJXBvc3RuYW1lJS8ifX0seyJzdGVwIjoiaW5zdGFsbFBsdWdpbiIsInBsdWdpbkRhdGEiOnsicmVzb3VyY2UiOiJ3b3JkcHJlc3Mub3JnL3BsdWdpbnMiLCJzbHVnIjoiZnJpZW5kcyJ9LCJvcHRpb25zIjp7ImFjdGl2YXRlIjp0cnVlfX0seyJzdGVwIjoicnVuUEhQIiwiY29kZSI6Ijw%2FcGhwIHJlcXVpcmVfb25jZSAnd29yZHByZXNzL3dwLWxvYWQucGhwJztcbmlmICggY2xhc3NfZXhpc3RzKCdGcmllbmRzXFxJbXBvcnQnKSkge1xuRnJpZW5kc1xcSW1wb3J0OjpvcG1sKFwiPD94bWwgdmVyc2lvbj1cXFwiMS4wXFxcIiBlbmNvZGluZz1cXFwidXRmLThcXFwiPz48b3BtbCB2ZXJzaW9uPVxcXCIyLjBcXFwiPlxuPGhlYWQ%2BXG48dGl0bGU%2BU3Vic2NyaXB0aW9uczwvdGl0bGU%2BXG48L2hlYWQ%2BXG48Ym9keT5cbjxvdXRsaW5lIHRleHQ9XFxcIlN1YnNjcmlwdGlvbnNcXFwiIHRpdGxlPVxcXCJTdWJzY3JpcHRpb25zXFxcIj5cbjxvdXRsaW5lIHR5cGU9XFxcInJzc1xcXCIgdGV4dD1cXFwiQWxleCBLaXJrXFxcIiB0aXRsZT1cXFwiQWxleCBLaXJrXFxcIiB4bWxVcmw9XFxcImh0dHBzOi8vYWxleC5raXJrLmF0XFxcIiBodG1sVXJsPVxcXCJodHRwczovL2FsZXgua2lyay5hdFxcXCIgLz5cbjxvdXRsaW5lIHR5cGU9XFxcInJzc1xcXCIgdGV4dD1cXFwiQWRhbSBaaWVsacWEc2tpXFxcIiB0aXRsZT1cXFwiQWRhbSBaaWVsacWEc2tpXFxcIiB4bWxVcmw9XFxcImh0dHBzOi8vYWRhbWFkYW0uYmxvZ1xcXCIgaHRtbFVybD1cXFwiaHR0cHM6Ly9hZGFtYWRhbS5ibG9nXFxcIiAvPlxuPC9vdXRsaW5lPlxuPC9ib2R5PlxuPC9vcG1sPlwiKTtcbn0ifV19)
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.
Replaces the custom
ts-api-reference-generatortool that built markdown with a more useful typedoc setup that generates an HTML site available at https://wordpress.github.io/wordpress-playground