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.

Sign up for GitHub

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

Jump to bottom

Text document archetype documentation doesn't render correctly #3904

Closed
Wumpf opened this issue Oct 17, 2023 · 1 comment · Fixed by #4008
Closed

Text document archetype documentation doesn't render correctly #3904

Wumpf opened this issue Oct 17, 2023 · 1 comment · Fixed by #4008
Assignees
@emilk
Labels
🪳 bug Something isn't working 📖 documentation Improvements or additions to documentation 🏎️ Quick Issue Can be fixed in a few hours or less user-request This is a pressing issue for one of our users
Milestone
Triage

Comments

@Wumpf
Copy link
Member

Wumpf commented Oct 17, 2023

https://www.rerun.io/docs/reference/types/archetypes/text_document

It gets confused by the markdown within the code tags
image
@Wumpf Wumpf added 🪳 bug Something isn't working 📖 documentation Improvements or additions to documentation labels Oct 17, 2023
@Wumpf Wumpf added this to the 0.10 Polish (non-blocking) milestone Oct 17, 2023
@Wumpf Wumpf added the user-request This is a pressing issue for one of our users label Oct 17, 2023
@emilk
Copy link
Member

emilk commented Oct 23, 2023

It will always be problematic to embed a markdown ```-codeblock within markdown, so I suggest we switch the default text_document example to one that only show a few basic markdown features.

@emilk emilk added the 🏎️ Quick Issue Can be fixed in a few hours or less label Oct 23, 2023
@emilk emilk mentioned this issue Oct 24, 2023
Closed
@emilk emilk self-assigned this Oct 25, 2023
@emilk emilk mentioned this issue Oct 25, 2023
Merged
4 tasks
emilk added a commit that referenced this issue Oct 26, 2023
@emilk
Improve docs for TextDocument example (#4008)
fe9759a 
### What
* Closes #3904
* Closes #3905

This enabled the API-docs for the `TextDocument` example. To make sure
it renders correctly I needed to:

* Remove the ```-code block (for proper embedding in the website inside
of a ``` markdown block)
* Replace `""""` with `''''` in the python example, so it can be
embedded in a `"""`-docstring in the Python API docs


#### Python API docs:

![image](https://github.com/rerun-io/rerun/assets/1148717/e9d2b814-1aa6-4018-bc76-c53aa6dbc829)

#### Rust API docs:

![image](https://github.com/rerun-io/rerun/assets/1148717/9b013213-41c1-4692-bfb9-e29b0c592c9f)


### 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 [demo.rerun.io](https://demo.rerun.io/pr/4008) (if
applicable)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG

- [PR Build Summary](https://build.rerun.io/pr/4008)
- [Docs
preview](https://rerun.io/preview/a8947d56d39d866f14791d6bb57fafad32323c5b/docs)
<!--DOCS-PREVIEW-->
- [Examples
preview](https://rerun.io/preview/a8947d56d39d866f14791d6bb57fafad32323c5b/examples)
<!--EXAMPLES-PREVIEW-->
- [Recent benchmark results](https://ref.rerun.io/dev/bench/)
- [Wasm size tracking](https://ref.rerun.io/dev/sizes/)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@emilk emilk

Labels
🪳 bug Something isn't working 📖 documentation Improvements or additions to documentation 🏎️ Quick Issue Can be fixed in a few hours or less user-request This is a pressing issue for one of our users
Projects
None yet
Milestone
Triage
Development

Successfully merging a pull request may close this issue.

Improve docs for TextDocument example rerun-io/rerun
2 participants
@emilk @Wumpf