feat: add greptimedb-quickstart skill with onboarding card#2469
Merged
Conversation
… DocCardList in generated .md Signed-off-by: Dennis Zhuang <killme2008@gmail.com>
Deploying greptime-docs with
|
| Latest commit: |
0af4d81
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://bea911cd.greptime-docs.pages.dev |
| Branch Preview URL: | https://feature-add-agent-onboarding.greptime-docs.pages.dev |
Signed-off-by: Dennis Zhuang <killme2008@gmail.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds an “Agent Onboarding” entrypoint to the Getting Started overview pages, publishes the new greptimedb-quickstart AI skill (and mirrors all skills to stable URLs under the docs site), and improves the llms.txt/per-page .md outputs by post-processing MDX placeholders into plain markdown for agent consumption.
Changes:
- Add an
<AgentOnboarding />MDX card to Getting Started overview docs (en + zh, current + v1.0). - Add the new
skills/greptimedb-quickstart/SKILL.mdskill and ensure all skills are mirrored intostatic/via a prestart/prebuild script. - Extend
llms-txt-generatorpost-build processing to expand<DocCardList />and replace<AgentOnboarding />with plain markdown text.
Reviewed changes
Copilot reviewed 12 out of 13 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| versioned_docs/version-1.0/getting-started/overview.md | Adds <AgentOnboarding /> card to v1.0 English Getting Started overview. |
| docs/getting-started/overview.md | Adds <AgentOnboarding /> card to current English Getting Started overview. |
| i18n/zh/docusaurus-plugin-content-docs/version-1.0/getting-started/overview.md | Adds <AgentOnboarding /> card to v1.0 Chinese Getting Started overview. |
| i18n/zh/docusaurus-plugin-content-docs/current/getting-started/overview.md | Adds <AgentOnboarding /> card to current Chinese Getting Started overview. |
| src/components/AgentOnboarding/index.tsx | New onboarding card component with copy-to-clipboard. |
| src/components/AgentOnboarding/prompt.ts | Centralized locale-aware prompt + URLs shared by UI and generator. |
| src/components/AgentOnboarding/styles.module.css | Styling for the onboarding card layout and copy button. |
| src/plugins/llms-txt-generator.ts | Post-process generated markdown to expand DocCardList and replace AgentOnboarding. |
| skills/README.md | Documents the new quickstart skill and its hosted URL. |
| skills/greptimedb-quickstart/SKILL.md | Adds the new end-to-end GreptimeDB quickstart skill for agents. |
| scripts/sync-skill.mjs | New script to mirror skills into static/ for stable published URLs. |
| package.json | Runs skill sync in prestart/prebuild. |
| .gitignore | Ignores generated static/SKILL.md and static/skills/. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Dennis Zhuang <killme2008@gmail.com>
Signed-off-by: Dennis Zhuang <killme2008@gmail.com>
Contributor
|
@codex review |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: b38f115db5
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Signed-off-by: Dennis Zhuang <killme2008@gmail.com>
sunng87
approved these changes
May 18, 2026
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
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.
What's Changed in this PR
Describe the change in this PR
/skills/.DocCardListin generated.md.Thoroughly review
skills/greptimedb-quickstart/SKILL.md. @sunng87 @fengjiachunChecklist
sidebars.tsmatches the current document structure when you changed the document structure.