Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Show assets in generated package documentation #1188

Open
philpax opened this issue Nov 23, 2023 · 0 comments
Open

Show assets in generated package documentation #1188

philpax opened this issue Nov 23, 2023 · 0 comments
Labels
enhancement New feature or request topic:assets Asset loading, streaming, etc topic:docgen Documentation generation (`ambient cmd --open-docs`) features and bugs

Comments

@philpax
Copy link
Contributor

philpax commented Nov 23, 2023

At the time of writing, the docs generated for asset-only packages are more or less empty as they have no items of their own.

The documentation could be made much more useful if it showed a list of all assets present within the package (preferably with some filters), and potentially include a way to view each asset (#1151, being able to play back sound, etc). Ideally, it could stand in as an "asset browser" that users can easily get asset links from.

This would require getting all built assets from the asset build process (i.e. OutAsset), which is complicated by the current build process only including top-level OutAssets. All build pipelines would need to be updated to output OutAssets for each of their built asset files.

Additionally, the current docgen loads in the entire exported semantic state for the one package at the top of the package-tree it's building. That is, it doesn't know anything about the other packages or where they're located. It would have to have some understanding of this (exported semantic contains locators that can be resolved relative to the generated docs?) before asset lists could be generated per-package.

Once that's sorted, generating the actual list should be relatively straightforward, with some care put into how the list is viewed (options for list/thumbnails, sort order, etc). Supporting viewing the other asset types would be nice, too - would it be possible to use Ambient to render them?

@philpax philpax added enhancement New feature or request topic:assets Asset loading, streaming, etc topic:docgen Documentation generation (`ambient cmd --open-docs`) features and bugs labels Nov 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request topic:assets Asset loading, streaming, etc topic:docgen Documentation generation (`ambient cmd --open-docs`) features and bugs
Projects
None yet
Development

No branches or pull requests

1 participant