Skip to content

Conversation

@BastiaanOlij
Copy link
Contributor

This PR adds a new chapter to the XR manual detailing the contents of our enhanced startup script that we used in our XR demos in the Godot demos repository.

Our introduction contains a bare minimum script that forms the basis for all XR interfaces. This script adds specific details for OpenXR only and adds further context to a number of signals emitted by the OpenXR interface.
It also has further details on the unique nature of refresh rates on XR headsets and how to properly set things up.

@BastiaanOlij BastiaanOlij added enhancement topic:xr Related to XR documentation area:manual Issues and PRs related to the Manual/Tutorials section of the documentation labels Jan 13, 2024
@BastiaanOlij BastiaanOlij self-assigned this Jan 13, 2024
@BastiaanOlij BastiaanOlij force-pushed the a_better_xr_start_script branch from 8e8308b to f6f8583 Compare January 14, 2024 03:50
Copy link
Contributor

@skyace65 skyace65 left a comment

Choose a reason for hiding this comment

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

Finally read through everything, the instructions and explanations made sense. Not seeing any grammar errors.

There's a ton of lines that need to be broken up into multiple lines though:
93
95
171
173
175
267
269
275
380
415
448

@BastiaanOlij
Copy link
Contributor Author

There's a ton of lines that need to be broken up into multiple lines though:

Don't things just wrap automatically? Happy to start every sentence on a new line but generally I stick to paragraphing of information that belongs together. Formatting is as much about conveying information as the actual text.

@skyace65
Copy link
Contributor

They do but it makes it a bit harder to edit when everything is on one very long line, we don't have those anywhere else in the docs. I'm not sure I understand your point about paragraphing, When I say split into multiple lines I mean like lines 6 and 7 on this page, that's still one paragraph. I'm not asking you to break up those lines and add blank space between them, sorry if that wasn't clear.

@BastiaanOlij
Copy link
Contributor Author

They do but it makes it a bit harder to edit when everything is on one very long line, we don't have those anywhere else in the docs. I'm not sure I understand your point about paragraphing, When I say split into multiple lines I mean like lines 6 and 7 on this page, that's still one paragraph. I'm not asking you to break up those lines and add blank space between them, sorry if that wasn't clear.

Ah, so it's not adding in a hard newline and break the flow.. Ok no problem, I can clean that up

@BastiaanOlij BastiaanOlij force-pushed the a_better_xr_start_script branch from f6f8583 to 32584e5 Compare January 18, 2024 00:28
@BastiaanOlij
Copy link
Contributor Author

@skyace65 Let me know if it's better, the painful thing of making these changes is that all the line numbers change with it, so it was hard to check if I fixed all the places you identified :)

Copy link
Contributor

@skyace65 skyace65 left a comment

Choose a reason for hiding this comment

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

Looks good now!

@skyace65 skyace65 merged commit d847e27 into godotengine:master Jan 22, 2024
@skyace65
Copy link
Contributor

Thanks!

@BastiaanOlij BastiaanOlij deleted the a_better_xr_start_script branch May 2, 2024 00:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:manual Issues and PRs related to the Manual/Tutorials section of the documentation enhancement topic:xr Related to XR documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants