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

some docs refactoring #12828

Merged
merged 28 commits into from
Sep 22, 2023
Merged

some docs refactoring #12828

merged 28 commits into from
Sep 22, 2023

Conversation

amn41
Copy link
Contributor

@amn41 amn41 commented Sep 19, 2023

Proposed changes:

This is a fairly significant refactor of the docs. Intention is to have a clean path through the "getting started" and "key concepts" sections, with links out to the dm1 section "key concepts -> building classic assistants" when we feel it will hep the user (e.g. if they're wondering where something went).

  • The "LLM" subsection has been removed. Intent classifier went to the classic section (just under the normal list of components). Intentless and docsearch policies went to key concepts -> policies, configuration got combined with the rest of the config section.
  • Slot mapping information has been removed from the domain page. We may choose to re-add it.
  • Started working on an overview page of CALM.

(Jira tickets will be created for outstanding items)

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 requested a review from m-vdb September 20, 2023 09:23
@amn41 amn41 mentioned this pull request Sep 20, 2023
4 tasks
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.

Thanks for this massive overhaul. The new sidebar makes sense to me 👍🏻 and thanks a lot for keeping a list of TODOs. I can take care of creating the tasks (I will probably group a few of them together when it makes sense)

docs/docs/calm.mdx Show resolved Hide resolved
docs/docs/calm.mdx Show resolved Hide resolved
docs/docs/calm.mdx Show resolved Hide resolved
docs/docs/calm.mdx Show resolved Hide resolved
docs/docs/calm.mdx Outdated Show resolved Hide resolved
docs/docs/concepts/policies.mdx Outdated Show resolved Hide resolved
docs/docs/concepts/policies.mdx Outdated Show resolved Hide resolved
docs/docs/concepts/policies.mdx Show resolved Hide resolved
docs/docs/concepts/policies.mdx Show resolved Hide resolved
docs/docs/concepts/policies.mdx Show resolved Hide resolved
@m-vdb m-vdb marked this pull request as ready for review September 20, 2023 12:40
amn41 and others added 17 commits September 20, 2023 14:49
Co-authored-by: Maxime Vdb <[email protected]>
@sonarqubecloud
Copy link

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

@github-actions
Copy link
Contributor

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

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.

🚀

@amn41 amn41 merged commit 69571c9 into docs-dm2 Sep 22, 2023
98 checks passed
@amn41 amn41 deleted the docs-dm2-some-cleanup branch September 22, 2023 08:22
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