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

Improve documentation previews #5805

Merged
merged 10 commits into from
Apr 5, 2024
Merged

Improve documentation previews #5805

merged 10 commits into from
Apr 5, 2024

Conversation

jprochazk
Copy link
Member

@jprochazk jprochazk commented Apr 5, 2024

What

Documentation previews are now built from the latest production deployment on every PR that includes changes to markdown files in docs or examples.

Checklist

  • I have read and agree to Contributor Guide and the Code of Conduct
  • I've included a screenshot or gif (if applicable)
  • I have tested the web demo (if applicable):
  • The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG
  • If applicable, add a new check to the release checklist!

@jprochazk jprochazk added 📖 documentation Improvements or additions to documentation 🧑‍💻 dev experience developer experience (excluding CI) exclude from changelog PRs with this won't show up in CHANGELOG.md labels Apr 5, 2024
Copy link

github-actions bot commented Apr 5, 2024

Deployed docs

Commit Link
d71024c https://landing-hyy7k20e6-rerun.vercel.app

Copy link
Member

@jleibs jleibs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

@jleibs jleibs merged commit 453fd67 into main Apr 5, 2024
33 checks passed
@jleibs jleibs deleted the jan/doc-previews branch April 5, 2024 19:00
jleibs pushed a commit that referenced this pull request Apr 5, 2024
### What

Documentation previews are now built from the latest production
deployment on every PR that includes changes to markdown files in `docs`
or `examples`.

### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested the web demo (if applicable):
* Using newly built examples:
[rerun.io/viewer](https://rerun.io/viewer/pr/5805)
* Using examples from latest `main` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/5805?manifest_url=https://app.rerun.io/version/main/examples_manifest.json)
* Using full set of examples from `nightly` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/5805?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG
* [x] If applicable, add a new check to the [release
checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)!

- [PR Build Summary](https://build.rerun.io/pr/5805)
- [Docs
preview](https://rerun.io/preview/35c5f659949fd08ce283f077ea6de6217b38d432/docs)
<!--DOCS-PREVIEW-->
- [Examples
preview](https://rerun.io/preview/35c5f659949fd08ce283f077ea6de6217b38d432/examples)
<!--EXAMPLES-PREVIEW-->
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🧑‍💻 dev experience developer experience (excluding CI) 📖 documentation Improvements or additions to documentation exclude from changelog PRs with this won't show up in CHANGELOG.md
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants