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

Documentation: Guide update: Minecraft demo #5215

Merged
merged 10 commits into from
Jan 18, 2023

Conversation

diarmidmackenzie
Copy link
Contributor

Description:

4th of 4 updates to bring external glitch examples up-to-date & into the A-Frame repo, per #5207.

This one addresses the Minecraft Demo

Bring code from Glitch into A-Frame Examples
Code up-to-date with latest versions
Code and documentation match
Refernces to WebVR -> WebXR

<meta charset="utf-8">
<title>Aincraft</title>
<meta name="description" content="Aincraft">
<script src="https://aframe.io/releases/1.4.0/aframe.min.js"></script>
Copy link
Member

Choose a reason for hiding this comment

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

link to master build instead of hard coded version like other examples

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Can do. Reason I did it this way was so that the HTML could easily be copy/pasted to another context (e.g. Glitch) and still work.

A small helping hand for beginners who might want to play with the example code, without cloning the A-Frame repo.

But if you prefer consistency with the other examples, that's - just wanted to share this consideration...

Copy link
Contributor

Choose a reason for hiding this comment

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

I also commented on it in #5213 (comment)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed

@@ -0,0 +1,36 @@
/* global AFRAME */
Copy link
Member

Choose a reason for hiding this comment

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

showcase directory of the examples should illustrate concrete use cases and be distinct. aincraft sounds a bit abstract and overlaps a bit with others. I feel these should go into a different directory. Perhaps:

examples/docs/...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Moved to examples/docs and created a new section "Examples from Documentation" on the examples page.

Will do the same for other PRs, but it will make merging easier if we get this merged to master & then I update the other PRs.

},

update: function () {
const data = this.data;
Copy link
Member

Choose a reason for hiding this comment

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

no const, var for consistency

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed. I will look into adding linting rule for this.

@diarmidmackenzie
Copy link
Contributor Author

Hopefully this is ready to merge now. I prefer to get this one merged first, then I'll fix up the others to move examples from showcase folder to docs folder.


<p data-height="265" data-theme-id="dark" data-slug-hash="OpbwMJ" data-default-tab="html,result" data-user="mozvr" data-embed-version="2" data-pen-title="Minecraft VR Demo (Final)" data-preview="true" data-editable="true" class="codepen">See the Pen <a href="http://codepen.io/mozvr/pen/OpbwMJ/">Minecraft VR Demo (Final)</a> by mozvr (<a href="http://codepen.io/mozvr">@mozvr</a>) on <a href="http://codepen.io">CodePen</a>.</p>
[webxr]: https://immersiveweb.dev/

[demorecorded]: https://supermedium.com/superframe/scenes/aincraft/?avatar-recording=recording.json
Copy link
Member

Choose a reason for hiding this comment

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

link no longer available

@dmarcos dmarcos merged commit 96706c4 into aframevr:master Jan 18, 2023
@dmarcos
Copy link
Member

dmarcos commented Jan 18, 2023

Thanks for the patience

diarmidmackenzie added a commit to diarmidmackenzie/aframe that referenced this pull request Jan 19, 2023
dmarcos pushed a commit that referenced this pull request Mar 28, 2023
* Copy example from glitch

* Update example to use latest working code

* Add link to Community Components example

* Consistently use jsdelivr for CDN

* Update Title

* Update documentation of community components example

* Fix docs lint error

* Add comment explaining what to do if copy/pasting code.

* Tidy up.

* Move community components from "showcase" to "docs"

* Fix some bad links left over from #5215

* Use versioned release here

Docs will be auto-updated using per-release process.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants