Skip to content

Commit 5728b29

Browse files
author
Akki Parekh
committed
chore: pre-launch polish — CI, docs, package.json, status section
CI / workflows: - Add separate 'website' job to ci.yml — Docusaurus build validated on every PR - Upgrade deploy-website.yml Node version from 20 to 22 - Node badge in README reverted to >=18 (runtime minimum; CI matrix is 22/24) package.json: - Bump version 0.1.0 → 0.1.1 - Fix homepage URL to live docs site (was GitHub README anchor) README: - Add "Current Status" section (CLI MVP, local-first, no SaaS, Node >=18/CI 22+24) - Note npm run preview PR in Roadmap section SECURITY.md: - Remove placeholder "[create a security contact email]" line - Direct security reports to GitHub Security Advisories only ROADMAP.md: - Update Done section to v0.1.1 with Transcript Intake Agent + 82 tests - Add npm run preview as in-review item website/docs/roadmap.md: - Sync with ROADMAP.md (v0.1.1, correct test count, preview PR link) website/docs/safety.md: - Fix security reporting: use GitHub Security Advisories, not public issues
1 parent 33b380e commit 5728b29

8 files changed

Lines changed: 50 additions & 13 deletions

File tree

.github/workflows/ci.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,25 @@ jobs:
4040
run: npm run doctor
4141
env:
4242
DEVDOCS_PROVIDER: mock
43+
44+
website:
45+
name: Build Website (Docusaurus)
46+
runs-on: ubuntu-latest
47+
steps:
48+
- name: Checkout
49+
uses: actions/checkout@v4
50+
51+
- name: Setup Node.js
52+
uses: actions/setup-node@v4
53+
with:
54+
node-version: '22'
55+
cache: 'npm'
56+
cache-dependency-path: website/package-lock.json
57+
58+
- name: Install website dependencies
59+
run: npm ci
60+
working-directory: website
61+
62+
- name: Build website
63+
run: npm run build
64+
working-directory: website

.github/workflows/deploy-website.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ jobs:
2828
- name: Setup Node.js
2929
uses: actions/setup-node@v4
3030
with:
31-
node-version: 20
31+
node-version: '22'
3232
cache: npm
3333
cache-dependency-path: website/package-lock.json
3434

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
**Turn tutorial transcripts into beautiful developer documentation.**
66

7-
[![Node.js](https://img.shields.io/badge/node-%3E%3D22-brightgreen)](https://nodejs.org)
7+
[![Node.js](https://img.shields.io/badge/node-%3E%3D18-brightgreen)](https://nodejs.org)
88
[![TypeScript](https://img.shields.io/badge/TypeScript-5.x-blue)](https://typescriptlang.org)
99
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow)](LICENSE)
1010
[![OpenAI](https://img.shields.io/badge/OpenAI-supported-412991)](https://platform.openai.com)
@@ -31,6 +31,18 @@
3131

3232
---
3333

34+
## Current Status
35+
36+
**devdocs-forge-agent is a v0.1.1 CLI MVP** — ready for local testing, open-source contributions, and feedback.
37+
38+
- Runs locally from your terminal — not a hosted SaaS product
39+
- Mock mode generates real output with no API key required
40+
- Real providers (OpenAI, Anthropic, Gemini) require your own API key
41+
- Generated docs are first drafts — always review before publishing
42+
- CI tests on Node.js 22 and 24 (Ubuntu + macOS); minimum runtime: Node ≥ 18
43+
44+
---
45+
3446
> **⭐ If this project saves you documentation time, please star the repo so more developers can discover it.**
3547
3648
---
@@ -473,6 +485,7 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for full setup instructions.
473485
- [x] 11 documentation output modes
474486
- [x] Video Intake Guard (URL validation + tech classification + transcript check)
475487
- [x] `npm run demo` one-command demo
488+
- [ ] `npm run preview` — local browser preview of generated docs (in review, [PR #6](https://github.com/AnkitParekh007/devdocs-forge-agent/pull/6))
476489
- [ ] Ollama provider (local LLMs)
477490
- [ ] OpenRouter provider
478491
- [ ] Browser UI (React or Angular)

ROADMAP.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Want to work on something? Open an issue!
66

77
---
88

9-
## v0.1.x — Stability (Current)
9+
## v0.1.x — Stability (Current — v0.1.1)
1010

1111
| Feature | Status |
1212
|---------|--------|
@@ -20,7 +20,9 @@ Want to work on something? Open an issue!
2020
| Test suite (Vitest) | ✅ Done |
2121
| Example transcripts and outputs | ✅ Done |
2222
| Video Intake Guard (URL validation + tech classification) | ✅ Done |
23+
| Transcript Intake Agent (clipboard, paste, file import) | ✅ Done |
2324
| One-command demo (`npm run demo`) | ✅ Done |
25+
| `npm run preview` — local browser doc preview | 🔄 In review ([PR #6](https://github.com/AnkitParekh007/devdocs-forge-agent/pull/6)) |
2426

2527
---
2628

SECURITY.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,7 @@
1717

1818
If you discover a security vulnerability in devdocs-forge-agent, please **do not open a public GitHub issue**.
1919

20-
Instead:
21-
1. Email: [create a security contact email or use GitHub's private vulnerability reporting]
22-
2. Or use [GitHub Security Advisories](https://github.com/AnkitParekh007/devdocs-forge-agent/security/advisories/new) (private disclosure)
20+
Instead, use [GitHub Security Advisories](https://github.com/AnkitParekh007/devdocs-forge-agent/security/advisories/new) (private disclosure).
2321

2422
Include:
2523
- A description of the vulnerability

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "devdocs-forge-agent",
3-
"version": "0.1.0",
3+
"version": "0.1.1",
44
"description": "AI documentation agent that turns tutorial transcripts, demos, and recordings into developer docs",
55
"type": "module",
66
"bin": {
@@ -63,7 +63,7 @@
6363
"type": "git",
6464
"url": "https://github.com/AnkitParekh007/devdocs-forge-agent.git"
6565
},
66-
"homepage": "https://github.com/AnkitParekh007/devdocs-forge-agent#readme",
66+
"homepage": "https://ankitparekh007.github.io/devdocs-forge-agent/",
6767
"bugs": {
6868
"url": "https://github.com/AnkitParekh007/devdocs-forge-agent/issues"
6969
}

website/docs/roadmap.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,29 +7,31 @@ description: What's done, what's next, and what's planned for devdocs-forge-agen
77

88
# Roadmap
99

10-
## Done (v0.1.0)
10+
## Done (v0.1.1 — current)
1111

1212
- [x] Core generation pipeline (TypeScript, ESM, Commander)
1313
- [x] Mock, OpenAI, Anthropic, Gemini providers
1414
- [x] 11 output modes: docusaurus, blog, docs, gitbook, readme, faq, troubleshooting, lesson, social, changelog, seo
1515
- [x] Video Intake Guard — URL validation, tech classification, transcript requirement
16+
- [x] Transcript Intake Agent — clipboard, stdin paste, file import (.md/.txt/.vtt/.srt), stubs for OAuth + local media
1617
- [x] `inspect-url` and `validate-source` CLI commands
18+
- [x] `transcript` command with 5 subcommands
1719
- [x] `--url` and `--force` flags on generate
1820
- [x] `npm run demo` one-command demo in mock mode
1921
- [x] `npm run batch` for directory-level processing
2022
- [x] `npm run verify` output validation
2123
- [x] `npm run doctor` setup diagnostics
2224
- [x] Profile customization (`modes/_profile.md`)
23-
- [x] Zod config schema with full `video_intake` section
24-
- [x] 54-test Vitest suite
25+
- [x] Zod config schema with `video_intake` and `transcript_intake` sections
26+
- [x] 82-test Vitest suite (Node 22/24, Ubuntu + macOS)
2527

2628
## In progress / good first issues
2729

30+
- [ ] **`npm run preview`** — local browser preview of generated docs ([PR #6](https://github.com/AnkitParekh007/devdocs-forge-agent/pull/6))
2831
- [ ] **Ollama provider** — local LLM support ([#1](https://github.com/AnkitParekh007/devdocs-forge-agent/issues/1))
2932
- [ ] **OpenRouter provider** — access to 200+ models ([#2](https://github.com/AnkitParekh007/devdocs-forge-agent/issues/2))
3033
- [ ] **Mermaid diagram mode** — architecture diagrams from transcripts ([#3](https://github.com/AnkitParekh007/devdocs-forge-agent/issues/3))
3134
- [ ] **Better Docusaurus frontmatter** — smarter tag and sidebar_label extraction ([#4](https://github.com/AnkitParekh007/devdocs-forge-agent/issues/4))
32-
- [ ] **Minimal web preview** — browser preview before publishing ([#5](https://github.com/AnkitParekh007/devdocs-forge-agent/issues/5))
3335

3436
## Planned (v0.2.0)
3537

website/docs/safety.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,6 @@ The `review-checklist.md` in every output directory includes:
5757

5858
## Reporting issues
5959

60-
If you find a security issue, open a [GitHub issue](https://github.com/AnkitParekh007/devdocs-forge-agent/issues) or email the maintainer directly.
60+
For **security vulnerabilities**, please use [GitHub Security Advisories](https://github.com/AnkitParekh007/devdocs-forge-agent/security/advisories/new) (private disclosure) — do not open a public issue.
6161

6262
For general bugs and feature requests, use [GitHub Issues](https://github.com/AnkitParekh007/devdocs-forge-agent/issues).

0 commit comments

Comments
 (0)