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.

Sign up for GitHub

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

Jump to bottom

feat: 🎸 docs #1561

Merged
merged 2 commits into from
Nov 2, 2023
Merged

feat: 🎸 docs #1561

merged 2 commits into from
Nov 2, 2023

Conversation

StanGirard
Copy link
Collaborator

added algolia

Description

Please include a summary of the changes and the related issue. Please also include relevant motivation and context.

Checklist before requesting a review

Please delete options that are not relevant.

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented hard-to-understand areas
  • I have ideally added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged

Screenshots (if appropriate):

@StanGirard
feat: 🎸 docs
61522a4 
added algolia
@StanGirard StanGirard temporarily deployed to preview November 2, 2023 13:07 — with GitHub Actions Inactive
@dosubot dosubot bot added the area: docs Related to documentation or under the /docs directory label Nov 2, 2023
@vercel Vercel
Copy link

vercel bot commented Nov 2, 2023 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 2, 2023 1:24pm
quivr-strapi ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 2, 2023 1:24pm
quivrapp ❌ Failed (Inspect) Nov 2, 2023 1:24pm

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 2, 2023 •
edited
Loading

Risk Level 2 - /home/runner/work/quivr/quivr/docs/docusaurus.config.js

The code changes are mostly configuration settings for a Docusaurus site. There are no major risks associated with these changes. However, there are a few points to consider:

  1. Algolia API Key: The Algolia API key is included in the code. Although it's mentioned that it's safe to commit, it's generally a good practice to avoid committing API keys directly in the code. Consider using environment variables to store such sensitive information. This would look something like process.env.ALGOLIA_API_KEY.

  2. Error Handling: There is no error handling code present. While this might not be a problem in this specific case, it's a good practice to always include error handling code to ensure your application can gracefully handle any unexpected situations.

  3. Code Comments: The code is well commented which is good for maintainability and understanding the purpose of different code blocks. However, some comments are redundant and can be removed to improve readability.

  4. Consistency: The code is consistent in its style and formatting which is good for readability and maintainability.

🔑❌ (API Key committed directly in code), ⚠️ (No error handling), 💬🔄 (Redundant comments, but consistent code style)

Powered by Code Review GPT

@StanGirard StanGirard temporarily deployed to preview November 2, 2023 13:14 — with GitHub Actions Inactive
@StanGirard StanGirard merged commit 3a9b716 into main Nov 2, 2023
7 checks passed
@StanGirard StanGirard mentioned this pull request Nov 2, 2023
Merged
mamadoudicko pushed a commit that referenced this pull request Nov 3, 2023
@StanGirard
chore(main): release 0.0.104 (#1562)
f7771f9 
🤖 I have created a release *beep* *boop*
---


## 0.0.104 (2023-11-03)

## What's Changed
* feat: 🎸 docs by @StanGirard in
#1561
* style(prompts): update public prompts dropdown styling by @St-Bloom in
#1563
* feat: add remote notification config by @mamadoudicko in
#1547
* fix: fix button bad children error by @mamadoudicko in
#1564
* style: fix hidden contents by @mamadoudicko in
#1577

## New Contributors
* @St-Bloom made their first contribution in
#1563

**Full Changelog**:
v0.0.103...v0.0.104

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
coolCatalyst added a commit to coolCatalyst/quivr that referenced this pull request Jun 1, 2024
@coolCatalyst
chore(main): release 0.0.104 (#1562)
d44f871 
🤖 I have created a release *beep* *boop*
---


## 0.0.104 (2023-11-03)

## What's Changed
* feat: 🎸 docs by @StanGirard in
QuivrHQ/quivr#1561
* style(prompts): update public prompts dropdown styling by @St-Bloom in
QuivrHQ/quivr#1563
* feat: add remote notification config by @mamadoudicko in
QuivrHQ/quivr#1547
* fix: fix button bad children error by @mamadoudicko in
QuivrHQ/quivr#1564
* style: fix hidden contents by @mamadoudicko in
QuivrHQ/quivr#1577

## New Contributors
* @St-Bloom made their first contribution in
QuivrHQ/quivr#1563

**Full Changelog**:
QuivrHQ/quivr@v0.0.103...v0.0.104

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
area: docs Related to documentation or under the /docs directory
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@StanGirard