skrypt-ai 0.3.3 → 0.4.0

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 (97) hide show
  1. package/README.md +1 -1
  2. package/dist/auth/index.d.ts +0 -1
  3. package/dist/auth/index.js +3 -5
  4. package/dist/autofix/index.js +15 -3
  5. package/dist/cli.js +19 -4
  6. package/dist/commands/check-links.js +164 -174
  7. package/dist/commands/deploy.js +5 -2
  8. package/dist/commands/generate.js +206 -199
  9. package/dist/commands/i18n.js +3 -20
  10. package/dist/commands/init.js +47 -40
  11. package/dist/commands/lint.js +3 -20
  12. package/dist/commands/mcp.js +125 -122
  13. package/dist/commands/monitor.js +125 -108
  14. package/dist/commands/review-pr.js +1 -1
  15. package/dist/commands/sdk.js +1 -1
  16. package/dist/config/loader.js +21 -2
  17. package/dist/generator/organizer.d.ts +3 -0
  18. package/dist/generator/organizer.js +4 -9
  19. package/dist/generator/writer.js +2 -10
  20. package/dist/github/pr-comments.js +21 -8
  21. package/dist/plugins/index.js +1 -0
  22. package/dist/scanner/index.js +8 -2
  23. package/dist/template/docs.json +2 -1
  24. package/dist/template/next.config.mjs +3 -1
  25. package/dist/template/package.json +17 -14
  26. package/dist/template/public/favicon.svg +4 -0
  27. package/dist/template/public/search-index.json +1 -1
  28. package/dist/template/scripts/build-search-index.mjs +120 -25
  29. package/dist/template/src/app/api/chat/route.ts +11 -3
  30. package/dist/template/src/app/docs/README.md +28 -0
  31. package/dist/template/src/app/docs/[...slug]/page.tsx +141 -14
  32. package/dist/template/src/app/docs/auth/page.mdx +589 -0
  33. package/dist/template/src/app/docs/autofix/page.mdx +624 -0
  34. package/dist/template/src/app/docs/cli/page.mdx +217 -0
  35. package/dist/template/src/app/docs/config/page.mdx +428 -0
  36. package/dist/template/src/app/docs/configuration/page.mdx +86 -0
  37. package/dist/template/src/app/docs/deployment/page.mdx +112 -0
  38. package/dist/template/src/app/docs/error.tsx +20 -0
  39. package/dist/template/src/app/docs/generator/generator.md +504 -0
  40. package/dist/template/src/app/docs/generator/organizer.md +779 -0
  41. package/dist/template/src/app/docs/generator/page.mdx +613 -0
  42. package/dist/template/src/app/docs/github/page.mdx +502 -0
  43. package/dist/template/src/app/docs/llm/anthropic-client.md +549 -0
  44. package/dist/template/src/app/docs/llm/index.md +471 -0
  45. package/dist/template/src/app/docs/llm/page.mdx +428 -0
  46. package/dist/template/src/app/docs/llms-full.md +256 -0
  47. package/dist/template/src/app/docs/llms.txt +2971 -0
  48. package/dist/template/src/app/docs/not-found.tsx +23 -0
  49. package/dist/template/src/app/docs/page.mdx +0 -3
  50. package/dist/template/src/app/docs/plugins/page.mdx +1793 -0
  51. package/dist/template/src/app/docs/pro/page.mdx +121 -0
  52. package/dist/template/src/app/docs/quickstart/page.mdx +93 -0
  53. package/dist/template/src/app/docs/scanner/content-type.md +599 -0
  54. package/dist/template/src/app/docs/scanner/index.md +212 -0
  55. package/dist/template/src/app/docs/scanner/page.mdx +307 -0
  56. package/dist/template/src/app/docs/scanner/python.md +469 -0
  57. package/dist/template/src/app/docs/scanner/python_parser.md +1056 -0
  58. package/dist/template/src/app/docs/scanner/rust.md +325 -0
  59. package/dist/template/src/app/docs/scanner/typescript.md +201 -0
  60. package/dist/template/src/app/error.tsx +3 -3
  61. package/dist/template/src/app/icon.tsx +29 -0
  62. package/dist/template/src/app/layout.tsx +57 -7
  63. package/dist/template/src/app/not-found.tsx +35 -0
  64. package/dist/template/src/app/page.tsx +95 -11
  65. package/dist/template/src/components/ai-chat.tsx +26 -21
  66. package/dist/template/src/components/breadcrumbs.tsx +56 -12
  67. package/dist/template/src/components/copy-button.tsx +17 -3
  68. package/dist/template/src/components/docs-layout.tsx +202 -8
  69. package/dist/template/src/components/feedback.tsx +4 -2
  70. package/dist/template/src/components/footer.tsx +42 -0
  71. package/dist/template/src/components/header.tsx +56 -20
  72. package/dist/template/src/components/mdx/accordion.tsx +17 -13
  73. package/dist/template/src/components/mdx/callout.tsx +50 -37
  74. package/dist/template/src/components/mdx/card.tsx +24 -12
  75. package/dist/template/src/components/mdx/code-block.tsx +17 -3
  76. package/dist/template/src/components/mdx/code-group.tsx +78 -18
  77. package/dist/template/src/components/mdx/code-playground.tsx +3 -0
  78. package/dist/template/src/components/mdx/go-playground.tsx +3 -0
  79. package/dist/template/src/components/mdx/highlighted-code.tsx +178 -38
  80. package/dist/template/src/components/mdx/python-playground.tsx +2 -0
  81. package/dist/template/src/components/mdx/steps.tsx +6 -6
  82. package/dist/template/src/components/mdx/tabs.tsx +76 -8
  83. package/dist/template/src/components/page-header.tsx +19 -0
  84. package/dist/template/src/components/scroll-to-top.tsx +33 -0
  85. package/dist/template/src/components/search-dialog.tsx +251 -57
  86. package/dist/template/src/components/sidebar.tsx +137 -77
  87. package/dist/template/src/components/table-of-contents.tsx +29 -13
  88. package/dist/template/src/lib/highlight.ts +90 -31
  89. package/dist/template/src/lib/search.ts +14 -4
  90. package/dist/template/src/lib/theme-utils.ts +140 -0
  91. package/dist/template/src/styles/globals.css +397 -84
  92. package/dist/template/src/types/remark-gfm.d.ts +2 -0
  93. package/dist/utils/files.d.ts +9 -0
  94. package/dist/utils/files.js +33 -0
  95. package/dist/utils/validation.d.ts +4 -0
  96. package/dist/utils/validation.js +38 -0
  97. package/package.json +1 -4
@@ -0,0 +1,121 @@
1
+ ---
2
+ title: Pro Features
3
+ description: Advanced features available with Skrypt Pro
4
+ ---
5
+
6
+ Skrypt Pro ($19/mo) unlocks advanced documentation capabilities.
7
+
8
+ ## Feature Comparison
9
+
10
+ | Feature | Free | Pro |
11
+ |---------|------|-----|
12
+ | Auto-generation | ✓ | ✓ |
13
+ | Hosting (*.skrypt.sh) | ✓ | ✓ |
14
+ | Custom domain | ✓ | ✓ |
15
+ | Self-serve cron | ✓ | ✓ |
16
+ | **Codebase monitoring** | - | ✓ |
17
+ | **Autofix/heal** | - | ✓ |
18
+ | **Code example testing** | - | ✓ |
19
+ | **SDK generation** | - | ✓ |
20
+ | **GitHub Action** | - | ✓ |
21
+ | **MCP server** | - | ✓ |
22
+ | **AI chat** | - | ✓ |
23
+ | **Bot analytics** | - | ✓ |
24
+
25
+ ---
26
+
27
+ ## Codebase Monitoring
28
+
29
+ Detect when documentation drifts from code.
30
+
31
+ ```bash
32
+ skrypt monitor --since HEAD~10
33
+ ```
34
+
35
+ ```
36
+ ⚠️ 3 functions modified without doc updates:
37
+ - src/api/users.ts:createUser
38
+ - src/utils/auth.ts:validateToken
39
+
40
+ Run `skrypt autofix` to update documentation.
41
+ ```
42
+
43
+ ---
44
+
45
+ ## Autofix / Heal
46
+
47
+ Automatically update documentation when code changes.
48
+
49
+ ```bash
50
+ skrypt autofix
51
+ ```
52
+
53
+ ---
54
+
55
+ ## Code Example Testing
56
+
57
+ Validate that code examples actually work.
58
+
59
+ ```bash
60
+ skrypt test
61
+ ```
62
+
63
+ ```
64
+ ✓ docs/api/users.mdx - 4 examples passed
65
+ ✗ docs/api/billing.mdx - 1 failed
66
+
67
+ Example at line 45:
68
+ TypeError: subscription.cancel is not a function
69
+ ```
70
+
71
+ ---
72
+
73
+ ## SDK Generation
74
+
75
+ Generate code samples in 8 languages.
76
+
77
+ ```bash
78
+ skrypt sdk --openapi ./api.yaml --output ./docs/sdks
79
+ ```
80
+
81
+ Languages: TypeScript, Python, Go, Rust, Java, PHP, Ruby, cURL
82
+
83
+ ---
84
+
85
+ ## MCP Server
86
+
87
+ Expose documentation as AI tools.
88
+
89
+ ```bash
90
+ skrypt mcp
91
+ ```
92
+
93
+ Works with Claude Desktop, Cursor, and MCP-compatible clients.
94
+
95
+ ---
96
+
97
+ ## Bot Analytics
98
+
99
+ Track AI bot traffic:
100
+
101
+ - GPTBot (ChatGPT)
102
+ - ClaudeBot (Claude)
103
+ - PerplexityBot
104
+ - Cursor / Windsurf
105
+
106
+ ---
107
+
108
+ ## Getting Started
109
+
110
+ ```bash
111
+ skrypt login
112
+ skrypt monitor
113
+ skrypt autofix
114
+ ```
115
+
116
+ ## Enterprise
117
+
118
+ Contact [enterprise@skrypt.sh](mailto:enterprise@skrypt.sh) for:
119
+ - Dedicated support
120
+ - Custom integrations
121
+ - SLA guarantees
@@ -0,0 +1,93 @@
1
+ ---
2
+ title: Quickstart
3
+ description: Generate your first documentation in 5 minutes
4
+ ---
5
+
6
+ Get from code to published docs in under 5 minutes.
7
+
8
+ ## Install
9
+
10
+ ```bash
11
+ npm install -g skrypt-ai
12
+ ```
13
+
14
+ ## Initialize
15
+
16
+ Create a new documentation site:
17
+
18
+ ```bash
19
+ skrypt init ./docs --name my-project
20
+ cd docs
21
+ npm install
22
+ ```
23
+
24
+ ## Generate Docs
25
+
26
+ Point Skrypt at your source code:
27
+
28
+ ```bash
29
+ skrypt generate ../src -o ./src/app/docs --provider openai
30
+ ```
31
+
32
+ Skrypt will:
33
+ 1. Scan your codebase for functions, classes, and types
34
+ 2. Generate documentation with AI-powered explanations
35
+ 3. Create runnable code examples
36
+ 4. Output MDX files ready for your docs site
37
+
38
+ ## Preview
39
+
40
+ ```bash
41
+ npm run dev
42
+ ```
43
+
44
+ Open [http://localhost:3000](http://localhost:3000) to see your docs.
45
+
46
+ ## Deploy
47
+
48
+ Push to Skrypt Cloud with one command:
49
+
50
+ ```bash
51
+ skrypt deploy
52
+ ```
53
+
54
+ Your docs are now live at `https://your-project.skrypt.sh`.
55
+
56
+ ---
57
+
58
+ ## Configuration
59
+
60
+ Create `skrypt.config.yaml` for persistent settings:
61
+
62
+ ```yaml
63
+ source: ./src
64
+ output: ./docs/src/app/docs
65
+ provider: openai
66
+ model: gpt-4o
67
+
68
+ options:
69
+ publicOnly: true
70
+ multiLang: false
71
+ byTopic: false
72
+ llmsTxt: true
73
+
74
+ exclude:
75
+ - "**/*.test.ts"
76
+ - "**/__mocks__/**"
77
+ - "internal/*"
78
+ ```
79
+
80
+ Then just run:
81
+
82
+ ```bash
83
+ skrypt generate
84
+ ```
85
+
86
+ ---
87
+
88
+ ## Next Steps
89
+
90
+ - [CLI Reference](/docs/cli) - All commands and options
91
+ - [Configuration](/docs/configuration) - Full config file reference
92
+ - [Deployment Guide](/docs/deployment) - Self-hosting and cloud options
93
+ - [Pro Features](/docs/pro) - Monitor, autofix, SDK generation