Skip to content
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

Merged
merged 15 commits into from
Oct 17, 2023
Merged

Docs cleanup components #12865

merged 15 commits into from
Oct 17, 2023

Conversation

amn41
Copy link
Contributor

@amn41 amn41 commented Sep 25, 2023

Proposed changes:

Status (please check what you already did):

  • added some tests for the functionality
  • updated the documentation
  • updated the changelog (please check changelog for instructions)
  • reformat files using black (please check Readme for instructions)

@amn41 amn41 marked this pull request as ready for review September 28, 2023 08:04
@amn41 amn41 requested a review from m-vdb September 28, 2023 08:04
Copy link
Collaborator

@m-vdb m-vdb left a 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 Show resolved Hide resolved
docs/docs/concepts/components/llm-configuration.mdx Outdated Show resolved Hide resolved
docs/docs/concepts/components/llm-configuration.mdx Outdated Show resolved Hide resolved
docs/docs/concepts/components/overview.mdx Show resolved Hide resolved
docs/docs/concepts/components/overview.mdx Outdated Show resolved Hide resolved
docs/docs/concepts/components/overview.mdx Outdated Show resolved Hide resolved
docs/docs/concepts/components/overview.mdx Show resolved Hide resolved
docs/docs/concepts/components/overview.mdx Outdated Show resolved Hide resolved
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",
Copy link
Collaborator

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?

Copy link
Contributor Author

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.

Copy link
Collaborator

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".

Copy link
Contributor Author

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

@amn41 amn41 requested a review from m-vdb September 28, 2023 11:48
@sonarcloud
Copy link

sonarcloud bot commented Oct 17, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

warning 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.
Read more here

@amn41
Copy link
Contributor Author

amn41 commented Oct 17, 2023

@m-vdb sorry for long wait - made the change you suggested.

@github-actions
Copy link
Contributor

🚀 A preview of the docs have been deployed at the following URL: https://12865--rasahq-docs-rasa-v2.netlify.app/docs/rasa

@m-vdb m-vdb merged commit 3e1e40d into docs-dm2 Oct 17, 2023
100 checks passed
@m-vdb m-vdb deleted the docs-cleanup-components branch October 17, 2023 14:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants