Add manifest + readmes to examples #2309
Conversation
jprochazk
added
📖 documentation
|
This PR is already somewhat large, so I'd like to do #2313 in a follow-up. |
|
@jprochazk: is there a rendered preview somewhere? |
|
The main issue I have right now is that this section isn't named and easily findable on the left navigation. That's actually an issue for the regular docs as well but here it's particularly problematic as it includes setup instructions. I also think the minimal example should probably just be the top entry in the synthetic data section. If changing any of these is too big I think it's totally fine to do it in a follow up PR though |
There was a problem hiding this comment.
Nice! Seems like a good start to me. I'd like a README in the examples folder that explains a little about how this works and how to view the rendered examples page (locally and with preview).
When all this is merged we should also make sure to auto include a link to the examples docs preview to all PRs (using template I guess?)
| ## Setup | ||
|
|
||
| Make sure you have the Rerun repository checked out and the latest SDK installed. | ||
|
|
||
| ```bash | ||
| pip install --upgrade rerun-sdk # install the latest Rerun SDK | ||
| git clone [email protected]:rerun-io/rerun.git # Clone the repository | ||
| cd rerun | ||
| git checkout latest # Check out the commit matching the latest SDK release | ||
| ``` | ||
| > Note: Make sure your SDK version matches the examples. | ||
| For example, if your SDK version is `0.3.1`, check out the matching tag | ||
| in the Rerun repository by running `git checkout v0.3.1`. |
There was a problem hiding this comment.
I think this might make sense as a stand alone page as well. Is it possible to create pages with things like setup instructions that are not connected to an example?
There was a problem hiding this comment.
Not with the current setup, I can do this part as a follow-up
Co-authored-by: Nikolaus West <[email protected]>
|
I made some changes here:
New preview: https://landing-iti1buuox-rerun.vercel.app/examples/real-data Will merge this in now, with more stuff coming as a follow-up |
<!-- Open the PR up as a draft until you feel it is ready for a proper review. Do not make PR:s from your own `main` branch, as that makes it difficult for reviewers to add their own fixes. Add any improvements to the branch as new commits to make it easier for reviewers to follow the progress. All commits will be squashed to a single commit once the PR is merged into `main`. Make sure you mention any issues that this PR closes in the description, as well as any other related issues. To get an auto-generated PR description you can put "copilot:summary" or "copilot:walkthrough" anywhere. --> ### What Closes #2268 Part of #2267 Adding a `manifest.yml` file which is used by `landing` to render examples in the documentation, and a `README.md` to each example. GitHub renders frontmatter as a table, I'm not sure if we want to go with that anymore. It's also possible to do something else, like a comment at the top with a custom format, which wouldn't be displayed, but would still be present in the file which `landing` downloads, and could then be used to store the same metadata. ### Checklist * [ ] 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) * [ ] I've included a screenshot or gif (if applicable) <!-- This line will get updated when the PR build summary job finishes. --> PR Build Summary: https://build.rerun.io/pr/2309 <!-- pr-link-docs:start --> Docs preview: https://rerun.io/preview/a05e331/docs <!-- pr-link-docs:end --> --------- Co-authored-by: Nikolaus West <[email protected]>
emilk
changed the title
What
Closes #2268
Part of #2267
Adding a
manifest.ymlfile which is used bylandingto render examples in the documentation, and aREADME.mdto each example.GitHub renders frontmatter as a table, I'm not sure if we want to go with that anymore. It's also possible to do something else, like a comment at the top with a custom format, which wouldn't be displayed, but would still be present in the file which
landingdownloads, and could then be used to store the same metadata.Checklist
PR Build Summary: https://build.rerun.io/pr/2309
Docs preview: https://rerun.io/preview/a05e331/docs