chore(eng-docs): add docs for knowledge gaps #3976
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
|
dosubot
bot
added
the
size:M
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
krisantrobus
commented
Jul 5, 2024
Comment on lines
+84
to
+88
| { | ||
| type: "add", | ||
| path: "packages/paste-core/{{component-type}}/{{kebabCase component-name}}/CHANGELOG.md", | ||
| templateFile: "tools/plop-templates/CHANGELOG.hbs", | ||
| }, |
There was a problem hiding this comment.
This is a mandatory file that is needed when developing the website section for new components. Good to add it in at gen level to stop getting caught out and manually having to update the components package later.
☁️ Nx Cloud ReportCI is running/has finished running commands for commit c9bd6e9. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 2 targetsSent with 💌 from NxCloud. |
github-actions
bot
added
the
Status: Do Not Merge
github-actions
bot
added
Area: Infrastructure
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| @@ -16,7 +16,7 @@ The same happens with Github discussions. The discussion is a page and is split | |||
|
|
|||
| We can then perform a similarity search using the user input as the query. | |||
|
|
|||
| Embeddings are generated using the the [embedding script](../../../packages/paste-website/scripts/search/). | |||
| Embeddings are generated using the the [embedding script](../../../packages/paste-website/scripts/search/). For a more detailed explanation of generating embeddings and running locally refernce [generating-embeddings](./generating-embeddings.md). | |||
There was a problem hiding this comment.
[misspell] reported by reviewdog 🐶
"refernce" is a misspelling of "references"
| - **page**: Stores the metadata of the entry. Key columns are the checksum (used to determine whether to update the record), path (either the url of the page or the github discussion), type (github-discussion or markdown) | ||
| - **page_sections**: contains the search embeddings. Key columns are content (plain text headings/titles), embedding (the vector spaces created from OpenAI), slug (yo string of content or the discussion/answer in GitHub). | ||
|
|
||
| Both tables are related with page being thge parent. They are joined by `page.id on page_section.page_id`. |
There was a problem hiding this comment.
[misspell] reported by reviewdog 🐶
"thge" is a misspelling of "the"
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit c9bd6e9:
|
|
Size Change: 0 B Total Size: 1.07 MB ℹ️ View Unchanged
|
Passing run #8179 ↗︎
Details:
Review all test suite changes for PR #3976 ↗︎ |
|||||||||||||||
serifluous
approved these changes
Jul 5, 2024
krisantrobus
added
the
🕵🏻♀️ Run website visual regression
Passing run #8182 ↗︎
Details:
Review all test suite changes for PR #3976 ↗︎ |
|||||||||||||||
krisantrobus
added
🚀 merge it!
and removed
Status: Do Not Merge
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I have reviewed the repo and identified areas that are missing documentation. This focusses on areas outside of the core development such as generating OpenAI embeddings and developing with the backend locally.