Mirrors/overte-JulianGro
3
0
Fork 0
mirror of https://github.com/JulianGro/overte.git synced 2025-04-07 23:02:24 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #71 from ctrlaltdavid/api-docs-branding

Browse source 
API docs rebranding
This commit is contained in:
kasenvr 2020-01-08 16:45:26 -05:00 committed by GitHub
commit fd4248db1d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 7 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
tools/jsdoc/api-mainpage.md
View file

@ -1,4 +1,4 @@
The High Fidelity JavaScript API lets content creators and developers create new experiences and transform virtual worlds within the High Fidelity metaverse. With it, you can build great content, customize avatars, play audio and so much more.
The Project Athena JavaScript API lets content creators and developers create new experiences and transform virtual worlds within the High Fidelity metaverse. With it, you can build great content, customize avatars, play audio and so much more.
You are most likely to interact with these APIs:
@ -6,4 +6,4 @@ You are most likely to interact with these APIs:
* The **[AvatarList](AvatarList.html)**, **[MyAvatar](MyAvatar.html)**, and **[Avatar](Avatar.html)** namespaces affect your personal avatars, and lets you get information on other people's avatars.
* The **[Script](Script.html)** namespace lets you to connect callbacks from your client to script, such as functionality that is dependent on time (`Script.update`, `Script.setTimeout`, `Script.setInterval`, etc), connect paths relatively to assets (`Script.resolvePath`), refer to other scripts (`Script.require`, `Script.include`), or connect functions to events which occur when the script is turned off (`Script.scriptEnding`).
To learn more about using High Fidelity and exploring the metaverse, visit the [High Fidelity Documentation](https://docs.highfidelity.com).
To learn more about using High Fidelity and exploring the metaverse, visit the [Project Athena Documentation](https://docs.projectathena.dev).

2
tools/jsdoc/hifi-jsdoc-template/publish.js
View file

@ -697,7 +697,7 @@ exports.publish = function(taffyData, opts, tutorials) {
var files = find({kind: 'file'});
var packages = find({kind: 'package'});
generate('', 'High Fidelity API Reference',
generate('', 'Project Athena API Reference',
packages.concat(
[{kind: 'mainpage', readme: opts.readme, longname: (opts.mainpagetitle) ? opts.mainpagetitle : 'Main Page'}]
).concat(files),

BIN
tools/jsdoc/hifi-jsdoc-template/static/images/fav-icon.ico
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 132 KiB

BIN
tools/jsdoc/hifi-jsdoc-template/static/images/project-athena-logo.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 213 KiB

BIN
tools/jsdoc/hifi-jsdoc-template/static/images/white-logo.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 49 KiB

1
tools/jsdoc/hifi-jsdoc-template/static/styles/jsdoc.css
View file

@ -67,6 +67,7 @@ h1
font-size: 3.25rem;
text-align: center;
margin: 50px 25px 25px;
line-height: 100%;
}
h2

5
tools/jsdoc/hifi-jsdoc-template/tmpl/layout.tmpl
View file

@ -12,15 +12,16 @@
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
<link href="images/fav-icon.ico" rel="shortcut icon">
</head>
<body>
<div class="nav-header">
<p><a href="https://www.highfidelity.com"><img src="images/white-logo.png" width="214px" /></a></p>
<p><a href="https://projectathena.io"><img src="images/project-athena-logo.png" width="214px" /></a></p>
<?js if (env.conf.docdash.search) { ?>
<input type="text" class="search-input" id="nav-search" placeholder="Search API Docs ..." />
<?js } ?>
<p><a href="https://docs.highfidelity.com">Looking for <strong>High Fidelity</strong><br /> Documentation?</a></p>
<p><a href="https://docs.projectathena.dev">Looking for <strong>Project Athena</strong><br /> Documentation?</a></p>
</div>
<nav>