@raybase/guide 0.0.2 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (59) hide show
  1. package/LICENSE +21 -0
  2. package/dist/cli.d.ts +8 -0
  3. package/dist/cli.d.ts.map +1 -0
  4. package/dist/cli.js +9 -0
  5. package/dist/cli.js.map +1 -0
  6. package/dist/guide-client.d.ts +48 -0
  7. package/dist/guide-client.d.ts.map +1 -0
  8. package/dist/guide-client.js +202 -0
  9. package/dist/guide-client.js.map +1 -0
  10. package/dist/guide-corpus.d.ts +64 -0
  11. package/dist/guide-corpus.d.ts.map +1 -0
  12. package/dist/guide-corpus.js +113 -0
  13. package/dist/guide-corpus.js.map +1 -0
  14. package/dist/guide-tables.d.ts +4 -0
  15. package/dist/guide-tables.d.ts.map +1 -0
  16. package/dist/guide-tables.js +17 -0
  17. package/dist/guide-tables.js.map +1 -0
  18. package/dist/guide.d.ts +164 -0
  19. package/dist/guide.d.ts.map +1 -0
  20. package/dist/guide.js +348 -0
  21. package/dist/guide.js.map +1 -0
  22. package/dist/index.d.ts +6 -0
  23. package/dist/index.d.ts.map +1 -0
  24. package/dist/index.js +6 -0
  25. package/dist/index.js.map +1 -0
  26. package/dist/install.d.ts +28 -0
  27. package/dist/install.d.ts.map +1 -0
  28. package/dist/install.js +18 -0
  29. package/dist/install.js.map +1 -0
  30. package/dist/runtime.d.ts +19 -0
  31. package/dist/runtime.d.ts.map +1 -0
  32. package/dist/runtime.js +136 -0
  33. package/dist/runtime.js.map +1 -0
  34. package/package.json +49 -8
  35. package/templates/astro-emdash/content/guide/capability-map.md +17 -0
  36. package/templates/astro-emdash/src/components/guide-widget.tsx +41 -0
  37. package/templates/astro-emdash/src/guide/actions.ts +8 -0
  38. package/templates/astro-emdash/src/guide/config.ts +21 -0
  39. package/templates/astro-emdash/src/guide/corpus.gen.ts +4 -0
  40. package/templates/astro-emdash/src/guide/corpus.manifest.json +72 -0
  41. package/templates/astro-emdash/src/guide/corpus.ts +4 -0
  42. package/templates/astro-emdash/src/guide/resources.json +4 -0
  43. package/templates/react-router/app/components/guide-widget.tsx +29 -0
  44. package/templates/react-router/app/guide/actions.ts +3 -0
  45. package/templates/react-router/app/guide/config.ts +21 -0
  46. package/templates/react-router/app/guide/corpus.gen.ts +4 -0
  47. package/templates/react-router/app/guide/corpus.manifest.json +22 -0
  48. package/templates/react-router/app/guide/corpus.ts +4 -0
  49. package/templates/react-router/app/guide/resources.json +4 -0
  50. package/templates/react-router/content/guide/capability-map.md +13 -0
  51. package/templates/tanstack-start/content/guide/capability-map.md +17 -0
  52. package/templates/tanstack-start/src/components/guide-widget.tsx +41 -0
  53. package/templates/tanstack-start/src/guide/actions.ts +17 -0
  54. package/templates/tanstack-start/src/guide/config.ts +21 -0
  55. package/templates/tanstack-start/src/guide/corpus.gen.ts +4 -0
  56. package/templates/tanstack-start/src/guide/corpus.manifest.json +22 -0
  57. package/templates/tanstack-start/src/guide/corpus.ts +4 -0
  58. package/templates/tanstack-start/src/guide/resources.json +4 -0
  59. package/README.md +0 -3
@@ -0,0 +1,22 @@
1
+ {
2
+ "schemaVersion": 1,
3
+ "generatedAt": "2026-06-23T05:51:54.320Z",
4
+ "sources": [
5
+ {
6
+ "kind": "guide",
7
+ "path": "content/guide"
8
+ }
9
+ ],
10
+ "documents": [
11
+ {
12
+ "id": "faq:capability-map.md",
13
+ "title": "What Guide can do in this app",
14
+ "source": "faq",
15
+ "text": "Guide should answer from the checked in app docs, help knowledge, and explicit Agent actions registered by the app. It can explain what the app tracks, where to go, how common workflows work, what the current user is allowed to do, and which tasks it can help perform. In the Team Tasks starter, Guide can summarize visible projects and tasks, list visible projects and tasks, create projects, create tasks, update task fields, mark tasks done, archive tasks or projects, and list assignable users through narrow declared app actions that share the same policies and invariants as the UI workflow. Guide should prefer archive over hard delete. It does not have hard delete actions in its allow list. If a user asks to permanently delete work, explain that deletion is handled from the app UI by someone with permission after the item is archived. When the app registers Agent actions, Guide may use those actions only after the user clearly asks and the action policy allows it. If no action is registered for a task, it can explain the workflow but should not claim it can perform the task. Guide should not expose raw tool names, internal errors, JSON, SQL, source code details, admin/operator capabilities, or implementation jargon. If context is missing or a tool fails, it should respond plainly, offer a useful next step, and ask one clarifying question only when needed.",
16
+ "public": false,
17
+ "guideContext": "app-capability-map",
18
+ "updatedAt": "2026-06-23T05:50:43.356Z",
19
+ "hash": "sha256:531e7a1160a7b21c50b7c5b6164873c7cde5114090dfc7aa544762c992548618"
20
+ }
21
+ ]
22
+ }
@@ -0,0 +1,4 @@
1
+ import type { GuideCorpusDocument } from "@raybase/guide";
2
+ import { generatedGuideCorpus } from "./corpus.gen";
3
+
4
+ export const guideCorpus = generatedGuideCorpus satisfies GuideCorpusDocument[];
@@ -0,0 +1,4 @@
1
+ {
2
+ "schemaVersion": 1,
3
+ "resources": []
4
+ }
package/README.md DELETED
@@ -1,3 +0,0 @@
1
- # @raybase/guide
2
-
3
- This name is reserved for Raybase. Nothing is released under it yet, and this package holds no code.