rudder-docs

Name: rudder-docs
Author: Undertone0809

247stars30forks

How to install rudder-docs?

undertone0809/rudder/rudder-docs

$npx -y skills add Undertone0809/rudder --skill rudder-docs

Installs into the current project.

Summary

Use when the user asks how Rudder works; needs current Rudder docs, exact behavior, commands, contracts, APIs, or source evidence; asks to create, hire, or configure Rudder agents; or asks to scaffold, develop, or verify Rudder plugins. For explicit creation requests, verify the

Files · 1

View on GitHub

SKILL.md

1	# Rudder Docs
2
3	Provide authoritative, current guidance about Rudder. This is Rudder's
4	documentation and self-knowledge entry point, not a workflow that must run merely because the agent is hosted by Rudder.
5
6	If this body is already present in the prompt but the current request does not need Rudder guidance, do not perform a docs lookup. Continue the user's actual task using the current tools and context.
7
8	## Purpose And Non-Goals
9
10	Classify the Rudder question, consult the smallest authoritative source set,
11	and answer with clear provenance. Use current evidence instead of memory for
12	commands, interfaces, versioned behavior, and product contracts.
13
14	This router does not make an ordinary hosted task into a Rudder workflow. It
15	does not provide a command catalog, replace runtime-owned execution rails, or
16	authorize an operation merely because it documents that operation.
17
18	## Classify The Request
19
20	Choose one primary class before retrieving evidence:
21
22	- Current capability or installed command: what this run exposes, which
23	CLI syntax is installed, or whether an exact operation is supported.
24	- Public product guidance: how a user should use or configure Rudder.
25	- Product contract: the intended semantics or invariant for a Rudder
26	feature.
27	- Contributor or source behavior: architecture, implementation location,
28	tests, API compatibility, or an exact source-level explanation.
29	- Discrepancy, troubleshooting, or release: observed behavior differs from
30	guidance, a Rudder operation failed, or the answer depends on a version.
31	- Explicit creation or authoring: the user asks to create, hire, or
32	configure a Rudder Agent, or to scaffold, develop, or verify a Rudder Plugin.
33	- Offline or restricted: the preferred live, public, or source evidence is
34	unavailable.
35
36	For a mixed question, resolve each material claim through its owning source
37	instead of applying one global priority.
38
39	## Choose The Source Route
40
41	### Current Run Capability And Installed CLI
42
43	Inspect exposed typed Rudder tools first. If capability discovery is needed,
44	use `rudder agent capabilities --json`; then use `rudder --version` and the
45	exact installed command's `--help`. Consult the relevant part of the CLI
46	reference only after those live checks. Use the API reference only for an
47	explicit internal, debugging, or compatibility question.
48
49	### Explicit Agent Or Plugin Work
50
51	For Agent creation or configuration, read
52	[Agent creation](references/agent-creation.md). For Plugin scaffolding or
53	authoring, read [Plugin authoring](references/plugin-authoring.md). Verify the
54	current typed capability, installed command, engineering contract, or source
55	before acting. Only an explicit user request to perform the creation or change
56	authorizes entering a mutation workflow; a question about how it works remains
57	read-only.
58
59	### Official Public Documentation
60
61	For public user guidance, start with
62	`https://docs.rudderhq.dev/llms.txt`. Open only one or two official pages
63	relevant to the request, prefer the user's language when an equivalent page exists, and link the
64	exact page. Do not crawl or load the whole site for a narrow question.
65
66	### Local Rudder Checkout
67
68	Follow the checkout's `AGENTS.md`, then use `doc/README.md` to choose the
69	documentation layer: `docs/` for public user guidance, `doc/product/` for the
70	intended product contract, `doc/engineering/` for contributor detail, and
71	source and tests for exact implementation. Search the owning area narrowly and
72	cite local paths and line numbers when supported.
73
74	### Official Remote Source And Releases
75
76	When local source is unavailable and source evidence is necessary, use only
77	the official `https://github.com/Undertone0809/rudder` repository and its
78	release or tag pages by default. Match the release tag to the installed version
79	when explaining installed behavior. Use the default branch only for explicit latest development questions, and label it as latest development, not installed behavior.
80
81	### Offline Or Restricted Fallback
82
83	Offline, use live capabilities and the relevant bundled references, and disclose
84	which preferred source was unavailable, the fallback used, and the resulting
85	limits. Missing evidence narrows the answer; it does not justify invention.
86
87	## Resolve Versions And Conflicts
88
89	Current callable or installed behavior wins for this environment.
90	`doc/product/` owns intended product sema

People who liked this also viewed

6 picks

Type

rudder-docs

247stars30forks

View on GitHub

How to install rudder-docs?

undertone0809/rudder/rudder-docs

$npx -y skills add Undertone0809/rudder --skill rudder-docs

Installs into the current project.

Summary

Files · 1

View on GitHub

SKILL.md

1	# Rudder Docs
2
3	Provide authoritative, current guidance about Rudder. This is Rudder's
4	documentation and self-knowledge entry point, not a workflow that must run merely because the agent is hosted by Rudder.
5
6	If this body is already present in the prompt but the current request does not need Rudder guidance, do not perform a docs lookup. Continue the user's actual task using the current tools and context.
7
8	## Purpose And Non-Goals
9
10	Classify the Rudder question, consult the smallest authoritative source set,
11	and answer with clear provenance. Use current evidence instead of memory for
12	commands, interfaces, versioned behavior, and product contracts.
13
14	This router does not make an ordinary hosted task into a Rudder workflow. It
15	does not provide a command catalog, replace runtime-owned execution rails, or
16	authorize an operation merely because it documents that operation.
17
18	## Classify The Request
19
20	Choose one primary class before retrieving evidence:
21
22	- Current capability or installed command: what this run exposes, which
23	CLI syntax is installed, or whether an exact operation is supported.
24	- Public product guidance: how a user should use or configure Rudder.
25	- Product contract: the intended semantics or invariant for a Rudder
26	feature.
27	- Contributor or source behavior: architecture, implementation location,
28	tests, API compatibility, or an exact source-level explanation.
29	- Discrepancy, troubleshooting, or release: observed behavior differs from
30	guidance, a Rudder operation failed, or the answer depends on a version.
31	- Explicit creation or authoring: the user asks to create, hire, or
32	configure a Rudder Agent, or to scaffold, develop, or verify a Rudder Plugin.
33	- Offline or restricted: the preferred live, public, or source evidence is
34	unavailable.
35
36	For a mixed question, resolve each material claim through its owning source
37	instead of applying one global priority.
38
39	## Choose The Source Route
40
41	### Current Run Capability And Installed CLI
42
43	Inspect exposed typed Rudder tools first. If capability discovery is needed,
44	use `rudder agent capabilities --json`; then use `rudder --version` and the
45	exact installed command's `--help`. Consult the relevant part of the CLI
46	reference only after those live checks. Use the API reference only for an
47	explicit internal, debugging, or compatibility question.
48
49	### Explicit Agent Or Plugin Work
50
51	For Agent creation or configuration, read
52	[Agent creation](references/agent-creation.md). For Plugin scaffolding or
53	authoring, read [Plugin authoring](references/plugin-authoring.md). Verify the
54	current typed capability, installed command, engineering contract, or source
55	before acting. Only an explicit user request to perform the creation or change
56	authorizes entering a mutation workflow; a question about how it works remains
57	read-only.
58
59	### Official Public Documentation
60
61	For public user guidance, start with
62	`https://docs.rudderhq.dev/llms.txt`. Open only one or two official pages
63	relevant to the request, prefer the user's language when an equivalent page exists, and link the
64	exact page. Do not crawl or load the whole site for a narrow question.
65
66	### Local Rudder Checkout
67
68	Follow the checkout's `AGENTS.md`, then use `doc/README.md` to choose the
69	documentation layer: `docs/` for public user guidance, `doc/product/` for the
70	intended product contract, `doc/engineering/` for contributor detail, and
71	source and tests for exact implementation. Search the owning area narrowly and
72	cite local paths and line numbers when supported.
73
74	### Official Remote Source And Releases
75
76	When local source is unavailable and source evidence is necessary, use only
77	the official `https://github.com/Undertone0809/rudder` repository and its
78	release or tag pages by default. Match the release tag to the installed version
79	when explaining installed behavior. Use the default branch only for explicit latest development questions, and label it as latest development, not installed behavior.
80
81	### Offline Or Restricted Fallback
82
83	Offline, use live capabilities and the relevant bundled references, and disclose
84	which preferred source was unavailable, the fallback used, and the resulting
85	limits. Missing evidence narrows the answer; it does not justify invention.
86
87	## Resolve Versions And Conflicts
88
89	Current callable or installed behavior wins for this environment.
90	`doc/product/` owns intended product sema

People who liked this also viewed

6 picks

Type