The docs are built using Docusaurus 2.
To run Docusaurus, install Node.js 12.x
.
Firstly, install python dependencies for Rasa:
$ make install
Then, install doc dependencies:
$ make install-docs
In order to build the docs, run:
$ make docs
Then, start doc server in watch mode:
$ make livedocs
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
$ yarn build
This command generates static content into the build
directory and can be served using any static contents hosting service.
Deployment is handled by Netlify: it is setup for listening to changes on the documentation
branch.
When a new docs version has been released, we'll need to do the following manual steps:
:::info
or :::caution
in all the docs files.docusaurus.config.js
in announcementBar
: update the Rasa versions
that are mentioned and link to the now previous major version documentation.netlify.toml
, under # Redirects for latest version permalinks
, by adjusting the
version number to the now new major version.When removing deprecated features, it will happen that some links become dead because they now link to parts of the docs that no longer exist. This usually happens in the CHANGELOG or migration links, and thankfully we do have CI checks that alert for dead links.
The trick here is to make these links point to previous versions of the docs. For instance, if the feature
you removed was documented at ./policies#mapping-policy
and the current latest version for the docs is 2.x
(this also means that the next version is 3.x
), then you can update the link to https://rasa.com/docs/rasa/2.x/policies#mapping-policy
.
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。