Don't show old API in the table of contents
This commit is contained in:
parent
f5d41db18a
commit
b79c946c52
|
@ -2,9 +2,9 @@
|
|||
|
||||
<div id="banner"><a href="https://github.com/jcbrand/converse.js/blob/master/docs/source/theming.rst">Edit me on GitHub</a></div>
|
||||
|
||||
=========================
|
||||
The new API documentation
|
||||
=========================
|
||||
=====================
|
||||
The API documentation
|
||||
=====================
|
||||
|
||||
This document is a stub. It shouldn't show at all, instead it's a hack in order
|
||||
to link to the JSDoc output.
|
||||
|
|
|
@ -23,7 +23,6 @@ or add new functionality to Converse.
|
|||
style_guide
|
||||
plugin_development
|
||||
api/index
|
||||
developer_api
|
||||
events
|
||||
other_frameworks
|
||||
builds
|
||||
|
|
|
@ -1,9 +1,15 @@
|
|||
# The Converse API documentation
|
||||
|
||||
Welcome to the new Converse API documentation, generated with
|
||||
[JSDoc](http://usejsdoc.org/).
|
||||
|
||||
The old (increasingly out of date and incomplete) API documentation is
|
||||
currently still [available here](/docs/htmls/developer_api.html).
|
||||
|
||||
## The public and private API
|
||||
|
||||
Converse has a public API and a private API.
|
||||
|
||||
r
|
||||
The reason we make this distinction between public and private is so that API
|
||||
methods which might can be used to "impersonate" the user, for example by
|
||||
sending messages on their behalf, are not available to random scripts running
|
||||
|
@ -12,7 +18,7 @@ in the websites.
|
|||
The public API is accessible via the `window.converse` global and is therefore
|
||||
available to all JavaScript running in the page.
|
||||
|
||||
The private API is only accessible to plugins, which have been whitelisted and
|
||||
Tehe private API is only accessible to plugins, which have been whitelisted and
|
||||
registered before `converse.initialize` (which is a public API method) has been
|
||||
called. See the [plugin development](https://conversejs.org/docs/html/plugin_development.html)
|
||||
section for more info on writing plugins.
|
||||
|
|
Loading…
Reference in New Issue
Block a user