Skip to content

Commit

Permalink
feat: add chatbot docs (#4316)
Browse files Browse the repository at this point in the history
  • Loading branch information
nicolethoen authored Oct 14, 2024
1 parent cd8f9a5 commit 31432c1
Show file tree
Hide file tree
Showing 13 changed files with 951 additions and 9 deletions.
3 changes: 2 additions & 1 deletion packages/documentation-site/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"screenshots": "pf-docs-framework screenshots"
},
"dependencies": {
"@patternfly/documentation-framework": "6.0.0-alpha.110",
"@patternfly/documentation-framework": "6.0.0-alpha.114",
"@patternfly/react-catalog-view-extension": "6.0.0-prerelease.1",
"@patternfly/react-console": "6.0.0-prerelease.2",
"@patternfly/react-docs": "7.0.0-prerelease.32",
Expand All @@ -27,6 +27,7 @@
"@patternfly/react-component-groups": "6.0.0-prerelease.4",
"@patternfly/react-virtualized-extension": "6.0.0-prerelease.4",
"@patternfly/quickstarts": "6.0.0-prerelease.2",
"@patternfly/virtual-assistant": "2.0.0-alpha.52",
"@patternfly/design-tokens": "1.13.0",
"react": "^17.0.0 || ^18.0.0",
"react-dom": "^17.0.0 || ^18.0.0",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,4 +78,4 @@ Currently, Red Hat:
- Requires review, testing, and validation of generative AI model output.
- Provides a few exceptions to this policy.

[View policy details (requires Red Hat login).](https://source.redhat.com/?signin&r=%2fdepartments%2flegal%2fglobal_legal_compliance%2fcompliance_folder%2fpolicy_on_the_use_of_ai_technologypdf)
[View policy details (requires Red Hat login).](https://source.redhat.com/?signin&r=%2fdepartments%2flegal%2fglobal_legal_compliance%2fcompliance_folder%2fpolicy_on_the_use_of_ai_technologypdf)
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,4 @@ Make sure to disclose any use of AI in chatbots. Our users should be able to tru

- Use labels and other visual styling cues to clearly identify AI features.
- Add necessary legal disclosures where you can, like in the chatbot footer.
- Display an indicator when the bot is "thinking" or "typing," so that users know to expect feedback.
- Display an indicator when the bot is "thinking" or "typing," so that users know to expect feedback.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,5 @@ import "@patternfly/react-topology/src/css/topology-pipelines.css";
import "@patternfly/react-log-viewer/src/LogViewer/css/log-viewer.css";
// Patternfly user feedback
import "@patternfly/react-user-feedback/src/Feedback/Feedback.css";
// Patternfly virtual assistant
import '@patternfly/virtual-assistant/dist/css/main.css';
Original file line number Diff line number Diff line change
Expand Up @@ -242,8 +242,26 @@ module.exports = (sourceMD, sourceProps, sourceFunctionDocs) => {
"design-guidelines"
);

// Virtual assistant (aka Chatbot)
const virtualAssistantPath = require
.resolve("@patternfly/virtual-assistant/package.json")
.replace("package.json", "src");

const virtualAssistantBase = require
.resolve("@patternfly/virtual-assistant/package.json")
.replace(
"package.json",
"patternfly-docs/content/extensions/virtual-assistant"
);

sourceProps(
path.join(virtualAssistantPath, "/**/*.tsx"),
reactPropsIgnore
);
sourceMD(path.join(virtualAssistantBase, 'examples/**/*.md'), 'PatternFly-AI');
sourceMD(path.join(virtualAssistantBase, '*.md'), 'PatternFly-AI');

// Prerelease sections:
// Component Groups extension (Currently in PRERELEASE, so only include in PRERELEASE builds)
if (process.env.PRERELEASE === "true") {
const reactVirtualizedTablePath = require
.resolve("@patternfly/react-virtualized-extension/package.json")
Expand Down
931 changes: 926 additions & 5 deletions yarn.lock

Large diffs are not rendered by default.

0 comments on commit 31432c1

Please sign in to comment.