Skip to content

feat(viewer): rewrite getting started as an end-to-end path - #141

Merged
Amoki merged 2 commits into
masterfrom
GabBimdata-patch-1-1
Aug 26, 2026
Merged

feat(viewer): rewrite getting started as an end-to-end path#141
Amoki merged 2 commits into
masterfrom
GabBimdata-patch-1-1

Conversation

@GabBimdata

Copy link
Copy Markdown
Contributor

The page stopped at the demo snippet. Readers who wanted to switch to their own data had to reassemble the path themselves across the API and Viewer sections.

The demo snippet now opens the page unchanged, so time to first render stays at zero. Everything else is new:

  • Add the "use your own models" path: application, cloud, project, model, token.
  • Move ProjectAccessToken into the viewer path. It was only documented in /api/guides/authentication, which is not where someone integrating the viewer looks. The current default path is pasting an ApiKey into the page.
  • Document the two main causes of a blank screen: ES modules blocked on file://, and a container with no height.
  • Add the ui config block for white labelling.
  • Move the format list to "Going further".
  • Link to existing reference pages instead of duplicating them.

The page stopped at the demo snippet. Readers who wanted to switch to
their own data had to reassemble the path themselves across the API and
Viewer sections.

The demo snippet now opens the page unchanged, so time to first render
stays at zero. Everything else is new:

- Add the "use your own models" path: application, cloud, project,
  model, token.
- Move ProjectAccessToken into the viewer path. It was only documented
  in /api/guides/authentication, which is not where someone integrating
  the viewer looks. The current default path is pasting an ApiKey into
  the page.
- Document the two main causes of a blank screen: ES modules blocked on
  file://, and a container with no height.
- Add the ui config block for white labelling.
- Move the format list to "Going further".
- Link to existing reference pages instead of duplicating them.
@GabBimdata GabBimdata added the documentation Improvements or additions to documentation label Aug 26, 2026
Comment thread src/viewer/index.md Outdated
@Amoki
Amoki merged commit 4e94f70 into master Aug 26, 2026
1 check passed
@Amoki
Amoki deleted the GabBimdata-patch-1-1 branch August 26, 2026 13:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants