-
Notifications
You must be signed in to change notification settings - Fork 4.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs cleanup components #12865
Docs cleanup components #12865
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
BTW the build is broken so I couldn't check a preview
docs/sidebars.js
Outdated
@@ -258,8 +255,11 @@ module.exports = { | |||
collapsed: true, | |||
items: [ | |||
"nlu-based-assistants/glossary", | |||
"concepts/components/custom-graph-components", | |||
"concepts/components/llm-custom", | |||
"concepts/components/graph-recipe", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
for me it makes more sense to keep this under the Components section. Can you explain your reasoning?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thinking is that components is under 'key concepts' which to me implies things you should understand as a Rasa user. IMO these pieces are not 'key' but rather advanced topics.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My worry is that we put things under the Reference section and it becomes a catch-all section for everything that doesn't fit with Key concept or the sections we added.
Because one key selling point of Rasa is to allow for customisation and configuration, it could actually make sense to have a section for building advanced assistants for pushing the boundaries of what Rasa bakes in by default. WDYT? I would see that section between "Operating at scale" and "Reference".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like that idea, especially if we can use it as a place to articulate what we consider the public facing API and what things are internal and you shouldn't touch unless you want to make your own life hard. But clearly outside the scope of this PR. Happy to put this back in key concepts for now
Co-authored-by: Maxime Vdb <[email protected]>
Co-authored-by: Maxime Vdb <[email protected]>
Co-authored-by: Maxime Vdb <[email protected]>
Co-authored-by: Maxime Vdb <[email protected]>
Co-authored-by: Maxime Vdb <[email protected]>
Kudos, SonarCloud Quality Gate passed! 0 Bugs No Coverage information The version of Java (11.0.20) you have used to run this analysis is deprecated and we will stop accepting it soon. Please update to at least Java 17. |
@m-vdb sorry for long wait - made the change you suggested. |
🚀 A preview of the docs have been deployed at the following URL: https://12865--rasahq-docs-rasa-v2.netlify.app/docs/rasa |
Proposed changes:
Status (please check what you already did):
black
(please check Readme for instructions)