This also drops the oldest upgrade guides for v1 - v2.2, because they
were far too difficult to maintain.
Change-Id: I9552891376d34f48e6424e862bd980f8ecc274c7
This change include the offline tutorial to show users how to set up
storage and use offline playback.
Change-Id: I470bfc6761a433116a766d338ac2a87eee1bde28
The FAQ file had to be moved into the tutorials folder to make this
work for some reason. JSDoc did not want to take "../faq" as a name.
Closes#865
Change-Id: I63ff5b181f494d72c04eaa054111d9fdc866064c
Also changes the jsdoc template for tutorials with children, to give
the tutorial content itself control over how the links to children are
formatted.
Also fixes annotations for the TextParser interface.
Change-Id: I99502f38bf711b74a596ad804d8abdddee5d6f4d
This allows network responses to have an X-Shaka-From-Cache header to
indicate that the response was somehow from a cache and should be
ignored for bandwidth calculations. For example, this can be from a
service worker intercepting the request.
Change-Id: I4dfdf4211921b7205febb58f1e80967f0c4841cd
This should be less awkward and artificial, and focuses more on the
debugging tools available than trying to solve a fictional problem.
Change-Id: Idc451115b777cea3ba84f68d489fe817f8bf0350
- Add prereqs section
- Add architecture diagrams
- Adjust doc margins
- Change some wording and fix typos
- Convert alert() to console.error() in basic usage tutorial
- Expand prose in debugging tutorial
- Add comments about asynchronous methods
- Expand description of Closure base
- Change some links to source rather than API docs
- Clarify some vague language
- Refactor some of the plugin text
Modified jsdoc to add a new 'linksource' tag to link directly to the
source code for an entity.
Change-Id: I6b879050fc59917ce98954a4fabd8afca60af456
- Update tutorial link in README
- Fix python version in README
- Move jsdoc conf to docs/ folder
- Add API docs main page
- Change style of inline code blocks
- Don't repeat tutorial title in jsdoc template
- (makes it easier to read tutorials on github as MD)
- Add tutorials for:
- Welcome to Shaka
- Basic Usage
- Debugging
- Configuration
- Networking and Buffering Configuration
- DRM Configuration
- License Server Authentication
- Plugins
- Tutorials still to come:
- License Headers and Track Restrictions
- Special Considerations for Live
- v2 Upgrade Guide
Change-Id: I16401c216cf4023d9097750ac7f6090c68bf3c9b
Jacob Trimble
Joey Parrish
Sandra Lokshina
Aaron Vaage