Unfurls/previews #12098
Assignees
Labels
Comments
|
Thanks @armcknight! I would even go as far as to not include the default image at all. But as we have very few images generally, would you be fine if we simply go with the page's description? If that is not present, with the first paragraph maybe? e.g., the page you linked does not have a page description: Which would result in: We could try to remove everything up to the last This example page has a description: so we would use the following text: |
|
Also, we should use |
what do you mean by this @stephanie-anderson ? |
|
We can make the image smaller also the heuristic for missing page descriptions will be very brittle (due to inevitable edge cases) We have 166 files in developer docs without a Developer Docs files without descriptiondevelop-docs/api-server/config.mdx develop-docs/api-server/application-domains/pii/selectors.mdx develop-docs/api-server/application-domains/pii/methods.mdx develop-docs/api-server/application-domains/pii/types.mdx develop-docs/api-server/application-domains/grouping.mdx develop-docs/api-server/application-domains/write-buffers.mdx develop-docs/api-server/application-domains/ab-testing/index.mdx develop-docs/api-server/application-domains/transaction-clustering/index.mdx develop-docs/api-server/application-domains/index.mdx develop-docs/api-server/application-domains/feature-flags/flagpole.mdx develop-docs/api-server/application-domains/feature-flags/options-backed-features.mdx develop-docs/api-server/application-domains/feature-flags/index.mdx develop-docs/api-server/application-domains/quotas.mdx develop-docs/api-server/application-domains/email.mdx develop-docs/api-server/application-domains/nodestore.mdx develop-docs/api-server/application-domains/outboxes.mdx develop-docs/api-server/application-domains/tsdb.mdx develop-docs/api-server/application-domains/digests.mdx develop-docs/api-server/application-domains/asynchronous-workers.mdx develop-docs/api-server/application-domains/kafka.mdx develop-docs/api-server/application-domains/database-migrations/index.mdx develop-docs/api-server/application-domains/metrics.mdx develop-docs/api-server/application-domains/translations.mdx develop-docs/api-server/application-domains/options.mdx develop-docs/api-server/issue-platform/index.mdx develop-docs/api-server/issue-platform/writing-detectors/index.mdx develop-docs/api-server/api/public.mdx develop-docs/api-server/api/serializers.mdx develop-docs/api-server/api/index.mdx develop-docs/api-server/api/concepts.mdx develop-docs/api-server/api/design.mdx develop-docs/api-server/api/basics.mdx develop-docs/api-server/api/checklist.mdx develop-docs/ingestion/relay-best-practices.mdx develop-docs/ingestion/projectconfig-versioning.mdx develop-docs/ingestion/transaction-span-ratelimits.mdx develop-docs/frontend/using-rtl.mdx develop-docs/frontend/upgrade-policies.mdx develop-docs/frontend/using-hooks.mdx develop-docs/frontend/component-library.mdx develop-docs/frontend/network-requests.mdx develop-docs/frontend/using-styled-components.mdx develop-docs/frontend/design-tenets.mdx develop-docs/frontend/pull-request-previews.mdx develop-docs/frontend/working-on-getting-started-docs.mdx develop-docs/development-infrastructure/devservices.mdx develop-docs/development-infrastructure/workflow.mdx develop-docs/development-infrastructure/environment/ports.mdx develop-docs/development-infrastructure/environment/u2f.mdx develop-docs/development-infrastructure/backend-development-server.mdx develop-docs/development-infrastructure/python-dependencies.mdx develop-docs/development-infrastructure/frontend-development-server.mdx develop-docs/application-architecture/overview.mdx develop-docs/application-architecture/sentry-vs-getsentry.mdx develop-docs/application-architecture/dynamic-sampling/outcomes.mdx develop-docs/application-architecture/dynamic-sampling/architecture.mdx develop-docs/application-architecture/dynamic-sampling/extrapolation.mdx develop-docs/application-architecture/dynamic-sampling/fidelity-and-biases.mdx develop-docs/application-architecture/feedback-architecture.mdx develop-docs/application-architecture/multi-region-deployment/index.mdx develop-docs/application-architecture/multi-region-deployment/control-silo.mdx develop-docs/application-architecture/multi-region-deployment/cross-region-replication.mdx develop-docs/application-architecture/multi-region-deployment/cross-region-rpc.mdx develop-docs/integrations/bitbucket.mdx develop-docs/integrations/discord/index.mdx develop-docs/integrations/gitlab.mdx develop-docs/integrations/github.mdx develop-docs/integrations/azuredevops.mdx develop-docs/integrations/heroku.mdx develop-docs/integrations/msteams/index.mdx develop-docs/integrations/pagerduty.mdx develop-docs/integrations/jira/index.mdx develop-docs/integrations/vercel.mdx develop-docs/integrations/slack/index.mdx develop-docs/integrations/jira-server.mdx develop-docs/sdk/research/performance/index.mdx develop-docs/sdk/miscellaneous/store.mdx develop-docs/sdk/miscellaneous/index.mdx develop-docs/sdk/miscellaneous/hub_and_scope_refactoring.mdx develop-docs/sdk/miscellaneous/unified-api/index.mdx develop-docs/sdk/expected-features/setup-wizards/index.mdx develop-docs/sdk/expected-features/rate-limiting.mdx develop-docs/sdk/expected-features/data-handling.mdx develop-docs/sdk/telemetry/replays.mdx develop-docs/sdk/telemetry/traces/backpressure.mdx develop-docs/sdk/telemetry/traces/tracing-without-performance.mdx develop-docs/sdk/telemetry/traces/span-data-conventions.mdx develop-docs/sdk/telemetry/traces/index.mdx develop-docs/sdk/telemetry/traces/trace-origin.mdx develop-docs/sdk/telemetry/traces/time-to-initial-full-display.mdx develop-docs/sdk/telemetry/traces/ui-event-transactions.mdx develop-docs/sdk/telemetry/traces/dynamic-sampling-context.mdx develop-docs/sdk/telemetry/traces/distributed-tracing/index.mdx develop-docs/sdk/telemetry/traces/modules/queries.mdx develop-docs/sdk/telemetry/traces/modules/index.mdx develop-docs/sdk/telemetry/traces/modules/requests.mdx develop-docs/sdk/telemetry/traces/modules/llm-monitoring.mdx develop-docs/sdk/telemetry/traces/modules/web-vitals.mdx develop-docs/sdk/telemetry/traces/modules/assets.mdx develop-docs/sdk/telemetry/traces/modules/app-starts.mdx develop-docs/sdk/telemetry/traces/modules/screen-loads.mdx develop-docs/sdk/telemetry/traces/modules/caches.mdx develop-docs/sdk/telemetry/traces/modules/queues.mdx develop-docs/sdk/telemetry/traces/frames-delay.mdx develop-docs/sdk/telemetry/traces/opentelemetry.mdx develop-docs/sdk/telemetry/traces/span-operations.mdx develop-docs/sdk/telemetry/scopes.mdx develop-docs/sdk/telemetry/spans/scrubbing-data.mdx develop-docs/sdk/telemetry/spans/sampling.mdx develop-docs/sdk/telemetry/spans/index.mdx develop-docs/sdk/telemetry/spans/filtering.mdx develop-docs/sdk/telemetry/client-reports.mdx develop-docs/sdk/telemetry/sessions/index.mdx develop-docs/sdk/telemetry/metrics.mdx develop-docs/sdk/telemetry/profiles/index.mdx develop-docs/sdk/telemetry/check-ins.mdx develop-docs/sdk/platform-specifics/serverless-sdks/aws-lambda.mdx develop-docs/sdk/platform-specifics/native-sdks/signal-handlers.mdx develop-docs/sdk/data-model/event-payloads/sdk.mdx develop-docs/sdk/data-model/event-payloads/user.mdx develop-docs/sdk/data-model/event-payloads/replay-recording.mdx develop-docs/sdk/data-model/event-payloads/breadcrumbs.mdx develop-docs/sdk/data-model/event-payloads/debugmeta.mdx develop-docs/sdk/data-model/event-payloads/threads.mdx develop-docs/sdk/data-model/event-payloads/span.mdx develop-docs/sdk/data-model/event-payloads/index.mdx develop-docs/sdk/data-model/event-payloads/transaction.mdx develop-docs/sdk/data-model/event-payloads/message.mdx develop-docs/sdk/data-model/event-payloads/exception.mdx develop-docs/sdk/data-model/event-payloads/properties/span_start_timestamp.mdx develop-docs/sdk/data-model/event-payloads/properties/span_timestamp.mdx develop-docs/sdk/data-model/event-payloads/properties/parent_span_id.mdx develop-docs/sdk/data-model/event-payloads/properties/measurements.mdx develop-docs/sdk/data-model/event-payloads/properties/contexts_trace.mdx develop-docs/sdk/data-model/event-payloads/properties/span_id.mdx develop-docs/sdk/data-model/event-payloads/properties/type.mdx develop-docs/sdk/data-model/event-payloads/properties/spans.mdx develop-docs/sdk/data-model/event-payloads/properties/op.mdx develop-docs/sdk/data-model/event-payloads/properties/description.mdx develop-docs/sdk/data-model/event-payloads/properties/tags.mdx develop-docs/sdk/data-model/event-payloads/properties/status.mdx develop-docs/sdk/data-model/event-payloads/properties/transaction_info.mdx develop-docs/sdk/data-model/event-payloads/properties/event_id.mdx develop-docs/sdk/data-model/event-payloads/properties/trace_id.mdx develop-docs/sdk/data-model/event-payloads/template.mdx develop-docs/sdk/data-model/event-payloads/contexts.mdx develop-docs/sdk/data-model/event-payloads/stacktrace.mdx develop-docs/sdk/data-model/event-payloads/lockreason.mdx develop-docs/sdk/data-model/event-payloads/request.mdx develop-docs/sdk/data-model/envelopes.mdx develop-docs/sdk/data-model/envelope-items.mdx develop-docs/self-hosted/backup.mdx develop-docs/self-hosted/experimental/reverse-proxy.mdx develop-docs/self-hosted/experimental/index.mdx develop-docs/self-hosted/experimental/external-storage.mdx develop-docs/self-hosted/experimental/errors-only.mdx develop-docs/self-hosted/experimental/csp.mdx develop-docs/self-hosted/custom-ca-roots.mdx develop-docs/self-hosted/support.mdx develop-docs/self-hosted/email.mdx develop-docs/self-hosted/troubleshooting.mdx develop-docs/self-hosted/releases.mdx develop-docs/self-hosted/geolocation.mdx develop-docs/self-hosted/sso.mdx develop-docs/services/filestore.mdx develop-docs/services/chartcuterie.mdx |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Problem Statement
Today, unfurls for develop.sentry.dev show nothing, and for docs.sentry.io mostly just show a large graphic, which clutters things quickly.
Solution Brainstorm
A nice middle ground would be to only use a small/icon image if one must be used, and then to have a summary of each page that can be shown as a textual preview. Ideally, the image preview would be a relevant image from the page or section if it exists, only falling back to the default if there are no other images.
Here are some examples:
The text was updated successfully, but these errors were encountered: