feat: add knowledge-base to Trieve upload #460
Conversation
- Add knowledge-base directory with FAQ/how-to articles - Update upload-to-trieve.js to recursively load knowledge-base .md files - Update workflow to trigger on knowledge-base changes - KB files prefixed with 'kb-' to avoid naming collisions on upload
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
This PR adds a comprehensive knowledge-base directory containing FAQ and how-to articles for Sei Network documentation, enhances the Trieve upload script to recursively process markdown files from this new directory, and updates the CI/CD workflow to trigger on knowledge-base changes. The implementation prefixes knowledge-base files with 'kb-' during upload to prevent naming collisions.
Key Changes:
- Added 50+ knowledge-base articles covering transactions, staking, smart contracts, precompiles, nodes, and compatibility
- Enhanced upload-to-trieve.js with recursive directory traversal for .md files
- Updated GitHub workflow to trigger on knowledge-base directory changes
Reviewed changes
Copilot reviewed 51 out of 51 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| scripts/upload-to-trieve.js | Added recursive file loading function for knowledge-base with improved error handling |
| .github/workflows/update-trieve-dataset.yml | Added knowledge-base path to workflow triggers |
| knowledge-base/**/*.md | 50+ comprehensive documentation files covering various Sei Network topics |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| #### Staking Rewards | ||
|
|
||
| - Current network reward rate is approximately **X%** annually (varies with network conditions) |
There was a problem hiding this comment.
Placeholder text "X%" should be replaced with actual or updated values. This appears to be template content that was not filled in. Consider either providing the actual current rate, linking to a dynamic source, or clarifying that rates vary and suggesting where users can check current rates.
|
|
||
| - You need SEI tokens in a **native Sei wallet** (not EVM) | ||
|
|
||
| - If your tokens are on the EVM side, [bridge them first](https://markdowntohtml.com/Bridging/01-native-evm-bridge.md) |
There was a problem hiding this comment.
Broken link reference. The link [bridge them first](https://markdowntohtml.com/Bridging/01-native-evm-bridge.md) points to a non-existent external domain "markdowntohtml.com" which appears to be a placeholder. This should be updated to point to the actual documentation location or removed if the referenced content doesn't exist yet.
|
|
||
| - Solution: Use alternative RPC endpoints or run your own node | ||
|
|
||
| - See: [Public RPC Endpoints](https://markdowntohtml.com/04-public-rpc-endpoints.md) |
There was a problem hiding this comment.
Multiple broken links to placeholder domain "markdowntohtml.com" found throughout the documentation. This appears to be a placeholder domain used for cross-references that should be updated to point to actual documentation locations. Files affected include:
- migrate-an-ethereum-dapp-to-sei-network.md (lines 185, 223, 239)
- move-sei-between-native-keplr-and-evm-metamask.md (lines 54, 56)
- can-standard-ethereum-contracts-be-deployed-to.md (line 53)
- stake-sei-tokens.md (line 12)
These should all be updated to use proper internal documentation links or removed if the target content doesn't exist yet.
| - See: [Public RPC Endpoints](https://markdowntohtml.com/04-public-rpc-endpoints.md) | |
| <!-- The following link was a placeholder. If a "Public RPC Endpoints" doc exists, link to it below. Otherwise, remove this line. --> |
|
|
||
| #### Unbonding Period | ||
|
|
||
| - SEI has a **7-day unbonding period** |
There was a problem hiding this comment.
The unbonding period stated as "7-day" conflicts with the 21-day period mentioned in another file. Line 80 states "SEI has a 7-day unbonding period" but knowledge-base/staking/stake-sei-tokens-and-what-is-the-current-apr-or.md:95 mentions "21-day unbonding period". These values should be consistent across the documentation.
|
I need to fix some broken links in these files from the export |
|
Going to close this for now, these backups given seem outdated. |
What is the purpose of the change?
This PR adds the exported knowledge base articles as a sub directory to this repo, so they can be uploaded to Trieve and searchable via MCP.
Describe the changes to the documentation
No changes to docs and these won't be visible on the docs site, just searchable via MCP.
Changelog