Skip to content

Commit 0f61806

Browse files
shettigarcclaude
andcommitted
chore: add MIT license and improve newguide workflow
- Add LICENSE file and license/copyright sections to README - Add Step 0 (git pull) to newguide skill to sync before starting - Add Step 3 (research) to newguide skill to verify docs accuracy Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent ec99eb0 commit 0f61806

File tree

3 files changed

+77
-6
lines changed

3 files changed

+77
-6
lines changed

.claude/skills/newguide/SKILL.md

Lines changed: 48 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,23 @@ If the user provided a topic as `$ARGUMENTS`, use it as the starting point for S
1313

1414
---
1515

16+
## Step 0 — Sync Repository
17+
18+
Before anything else, pull the latest code:
19+
20+
```bash
21+
git pull --rebase origin main
22+
```
23+
24+
If this fails due to unstaged changes, stash first:
25+
```bash
26+
git stash && git pull --rebase origin main && git stash pop
27+
```
28+
29+
Report: `Repository synced with origin/main.`
30+
31+
---
32+
1633
## Step 1 — Gather Intent
1734

1835
Respond with:
@@ -75,13 +92,38 @@ Wait for confirmation. If the user requests changes, revise and re-present. Loop
7592

7693
---
7794

78-
## Step 3 — Generate HTML
95+
## Step 3 — Research
96+
97+
Once the plan is confirmed, research the topic to ensure accuracy:
98+
99+
1. Use web search to find the **official documentation** for the tools/technologies in the guide
100+
2. Fetch key reference pages (man pages, official cheatsheets, CLI help docs) to verify:
101+
- Command syntax and flags are current
102+
- Keyboard shortcuts are accurate
103+
- Any recent changes or deprecations
104+
3. Cross-reference your knowledge with the fetched docs
105+
106+
Tell the user: `Researching latest docs for [topic]...`
107+
108+
Report what sources were consulted:
109+
```
110+
Sources checked:
111+
• [source 1 — url or description]
112+
• [source 2]
113+
...
114+
```
115+
116+
If a tool's docs are unavailable, note it and proceed with best available knowledge.
117+
118+
---
119+
120+
## Step 4 — Generate HTML
79121

80-
Once the plan is confirmed:
122+
After research is complete:
81123

82124
1. Read `.claude/docs/STYLE_GUIDE.md` fully
83125
2. Read `.claude/docs/COMPONENTS.md` fully
84-
3. Generate the complete guide HTML using the confirmed plan
126+
3. Generate the complete guide HTML using the confirmed plan and researched content
85127

86128
Tell the user: `Reading style guide and components... generating guide HTML.`
87129

@@ -125,7 +167,7 @@ Ready to preview.
125167

126168
---
127169

128-
## Step 4 — Preview
170+
## Step 5 — Preview
129171

130172
Automatically open preview:
131173

@@ -152,7 +194,7 @@ Review the guide in your browser.
152194

153195
---
154196

155-
## Step 5 — Iterate (if needed)
197+
## Step 6 — Iterate (if needed)
156198

157199
If the user requests changes:
158200
1. Understand the requested changes
@@ -165,7 +207,7 @@ Loop until the user is satisfied.
165207

166208
---
167209

168-
## Step 6 — Hand off to Publish
210+
## Step 7 — Hand off to Publish
169211

170212
When the user approves:
171213
```

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 Devteds
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,3 +57,11 @@ DevPages helps you create, preview, and publish beautiful standalone HTML guide
5757
- Node.js >= 16 (for build-index.js)
5858
- Git with push access to this repo
5959
- Claude Code CLI
60+
61+
## License
62+
63+
This project is licensed under the [MIT License](LICENSE).
64+
65+
## Copyright
66+
67+
© 2026 [Devteds](https://devteds.com). All rights reserved.

0 commit comments

Comments
 (0)