aframevr / aframevr/aframe

Frustrating Broken Documentation

Open
#5,154 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
17.6k
Forks
4.4k
PR merge metrics
No merged PRs in 30d

Description

Hi,

on the AFrame github home page there is a code sample (the that loads AFrame version https://aframe.io/releases/1.3.0/aframe.min.js but the Glitch link that demos this code sample loads AFrame version https://aframe.io/releases/0.5.0/aframe.min.js

The ocean component doesn't work with 1.3.0.

There are heaps of examples, really great examples, that don't work with 1.3.0 and are hosted on CodePen or wherever, but they're annoying as hell to come across because so many of the examples don't work with the current version of AFrame. And there are hundreds of examples out there in the wild on Glitch and elsewhere basically making 1.30 really hard to learn.

Whilst I appreciate that "things move on", can the official docs of AFrame do something to either flag that certain features/demos only work with previous versions, or even better, have a tidy up of the documentation, making sure that the linked samples and examples provided do work with the current version of AFrame.

Thanks

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the A-Frame GitHub home page code sample and its linked Glitch demo, then review the official examples mentioned in the issue. Check which samples use A-Frame 1.3.0 and which depend on older versions. Done means the affected links and examples are updated to work with the current version or clearly marked with their required version.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.