Ap get started - #128
Open
Corb3nik wants to merge 4 commits into
Open
Conversation
❌ Deploy Preview for caido-doc-developer failed.
|
Contributor
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 68.2%, saving 322.2 KB.
|
There was a problem hiding this comment.
Pull request overview
Adds a new “Get Started” entry point and a Plugins “Creating Your First Plugin” quickstart section to the Caido developer docs, wiring it into the VitePress nav and sidebar configuration.
Changes:
- Added a new
/introductionlanding page and repointed the home hero + top-level “Get Started” nav to it. - Introduced a new
/plugins/quickstart/documentation section with multiple step-by-step pages and a dedicated sidebar. - Updated VitePress navbars/sidebars exports and theme config to include the new introduction + quickstart routes.
Reviewed changes
Copilot reviewed 15 out of 39 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
src/plugins/quickstart/vibe_coding.md |
Adds “AI Assisted Coding” quickstart content. |
src/plugins/quickstart/store.md |
Documents submitting a plugin package to the store. |
src/plugins/quickstart/repository.md |
Documents setting up a repository, signing keys, and release process. |
src/plugins/quickstart/reload.md |
Documents hot reload workflow via Devtools + pnpm watch. |
src/plugins/quickstart/index.md |
Adds quickstart entry page for “Creating Your First Plugin”. |
src/plugins/quickstart/frontend.md |
Introduces frontend component/page basics with Vue/PrimeVue/Tailwind context. |
src/plugins/quickstart/documentation.md |
Adds contributor quickstart steps for this documentation repo. |
src/plugins/quickstart/config.md |
Adds walkthrough for configuring caido.config.ts. |
src/plugins/quickstart/build.md |
Adds instructions for building and installing the plugin package. |
src/plugins/quickstart/backend.md |
Adds backend API example used by the frontend demo. |
src/introduction.md |
Adds new top-level “Welcome” introduction page. |
src/index.md |
Updates home hero “Get Started” link to /introduction. |
.vitepress/sidebars/plugins/quickstart.ts |
Introduces a dedicated quickstart sidebar. |
.vitepress/sidebars/plugins/index.ts |
Re-exports the quickstart sidebar. |
.vitepress/sidebars/plugins/guides.ts |
Removes the old “Getting Started” group from the guides sidebar. |
.vitepress/navbars/quickstart.ts |
Removes the old quickstart navbar file. |
.vitepress/navbars/plugins.ts |
Adds a Plugins navbar entry for the quickstart. |
.vitepress/navbars/index.ts |
Refactors navbar exports and adds an introduction navbar. |
.vitepress/config.mts |
Wires introduction/quickstart nav + sidebar into the site config. |
|
|
||
| ## What's next? | ||
|
|
||
| You may have noticed that even though the plugin's display name was set to `Demo Plugin` in the `/demo/caido.config.ts` file, it is displayed as **</> My Plugin** in the side navigation menu. |
|
|
||
| ## What's next? | ||
|
|
||
| Once the dependencies have been installed, open the `demo` folder in a editor of your choice and continue with the [Configuring a Plugin](/plugins/guides/config.md) guide. |
|
|
||
| <img alt="Plugin template button." src="/_images/plugin_template_button.png" center/> | ||
|
|
||
| ```ts |
|
|
||
| 2. Next, run the following command from the root directory of the plugin to both build and watch for file changes: | ||
|
|
||
| ``` bash |
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.
No description provided.