Skip to content

Commit d1af4a3

Browse files
committed
feat: add roadmap document outlining version history and future plans
Introduce a new ROADMAP.md file detailing the current status, release plan, and version themes for the Developer Tools Directory. This document follows semantic versioning and provides a comprehensive overview of completed and planned features for future releases.
1 parent 0403243 commit d1af4a3

File tree

1 file changed

+180
-0
lines changed

1 file changed

+180
-0
lines changed

ROADMAP.md

Lines changed: 180 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,180 @@
1+
# Roadmap
2+
3+
> Developer Tools Directory roadmap. Versions follow semantic versioning.
4+
5+
## Current Status
6+
7+
**v1.1.0** - Centralized directory with 10 registered tools, scaffold generator, unified site template, and GitHub Pages catalog.
8+
9+
## Release Plan
10+
11+
| Version | Theme | Status |
12+
|---------|-------|--------|
13+
| v1.0.0 | Foundation | Released |
14+
| v1.1.0 | Unified Site Template | Released |
15+
| v1.2.0 | Cross-Repo Consistency | Next |
16+
| v1.3.0 | Content-Rich Pages | Planned |
17+
| v1.4.0 | Discovery and Performance | Planned |
18+
| v1.5.0 | Infrastructure and Documentation | Planned |
19+
20+
---
21+
22+
## v1.0.0 - Foundation
23+
24+
Initial release of the centralized directory.
25+
26+
- `registry.json` with schema for all developer tools
27+
- Standards documentation (CI/CD, GitHub Pages, repository structure, versioning)
28+
- Scaffold generator (`create-tool.py`) for new tool repos
29+
- GitHub Pages catalog site
30+
- CI validation of registry schema and scaffold dry-run
31+
- CodeQL, dependency review, stale issue, label sync workflows
32+
- `AGENTS.md`, `CLAUDE.md`, `CONTRIBUTING.md`, `SECURITY.md`
33+
- CC-BY-NC-ND-4.0 licensing
34+
35+
---
36+
37+
## v1.1.0 - Unified Site Template
38+
39+
Shared `site-template/` system consumed by all tool repos via CI.
40+
41+
- `build_site.py` renders GitHub Pages from `plugin.json`, `site.json`, skills, rules, and `mcp-tools.json`
42+
- `template.html.j2` with Jinja2 templating
43+
- Self-hosted Inter and JetBrains Mono fonts
44+
- Collapsible sections (all start collapsed)
45+
- MCP tool search/filter with `/` shortcut
46+
- Copy-to-clipboard on install steps
47+
- Back-to-top button, scroll spy, toast notifications
48+
- Animated stat counters with `prefers-reduced-motion` support
49+
- Mobile-responsive navigation
50+
- Hero section with logo from `plugin.logo`
51+
- Accent glow on section cards (`color-mix` box-shadow)
52+
- Light/dark mode (OS preference + manual 3-state toggle + localStorage)
53+
- Smooth expand/collapse height animation
54+
- Richer footer (social links, build date, version, directory link)
55+
- Scaffold templates updated (`pages.yml.j2`, `site.json.j2`, `mcp-tools.json.j2`)
56+
57+
---
58+
59+
## v1.2.0 - Cross-Repo Consistency
60+
61+
Audit and standardize all tool repos for uniform quality.
62+
63+
### README Style Audit
64+
- Unify badge format across all 4 tool repos (clickable `<a><img></a>`, consistent ordering)
65+
- Standardize structure: badges, description, features, quick-start, install, contributing, license
66+
- Ensure all READMEs use collapsible `<details>` sections for lengthy content
67+
68+
### CI Gaps
69+
- Audit which repos are missing: `codeql.yml`, `dependency-review.yml`, `label-sync.yml`, `release-drafter.yml`
70+
- Add missing workflows from scaffold templates to repos that lack them
71+
72+
### Directory Catalog Site Polish
73+
- Apply the same visual treatment from tool sites to `docs/index.html` in the directory repo
74+
- Dark/light mode toggle, accent glow on cards, richer footer, animations
75+
- Rewrite the older HTML structure to match the unified template aesthetic
76+
77+
---
78+
79+
## v1.3.0 - Content-Rich Pages
80+
81+
Enrich the tool sites with more useful data pulled at build time.
82+
83+
### Skill Detail Expansion
84+
- Click a skill row to expand inline with full description, trigger phrases, usage notes
85+
- `build_site.py` parses full `SKILL.md` body (not just name + first line)
86+
- JS toggle on `<tr>` click to show/hide a detail row
87+
88+
### Changelog Section
89+
- Parse each repo's `CHANGELOG.md` and render the most recent 3-5 entries
90+
- New collapsible "Changelog" section after Install
91+
92+
### Quick-Start Snippet
93+
- Prominent code block in the hero area or right after install for fastest path to usage
94+
- New `quickStart` field in `site.json`
95+
96+
### Compatibility Badges
97+
- Show supported Cursor versions, OS, Node/Python versions as pill badges
98+
- New `compatibility` object in `site.json`
99+
100+
### Related Tools Cross-Links
101+
- Each site links to other tools in the directory
102+
- New `relatedTools` array in `site.json` with `{ name, url }` entries
103+
- Rendered as a section before the footer
104+
105+
---
106+
107+
## v1.4.0 - Discovery and Performance
108+
109+
Make tools easier to find and sites faster to load.
110+
111+
### OG Image / Social Preview
112+
- Auto-generate branded `og:image` per repo at build time
113+
- Include repo logo, name, description, accent color
114+
- Store as `docs/assets/og.png`
115+
116+
### Global Search on Directory Catalog
117+
- Search bar on the directory catalog site filtering across all tools, skills, rules, and MCP tools
118+
- Build-time aggregation from `registry.json` and per-repo data
119+
120+
### Site Performance Audit
121+
- Lighthouse audit across all 5 sites
122+
- Optimize: font preloading, lazy-load below-fold content, minimize unused CSS
123+
- Document baseline and post-optimization scores
124+
125+
---
126+
127+
## v1.5.0 - Infrastructure and Documentation
128+
129+
Maintenance, documentation, and packaging consistency.
130+
131+
### Template Documentation
132+
- Flesh out `site-template/SETUP-PROMPT.md` with full `site.json` schema, `mcp-tools.json` format, `build_site.py` data flow, customization guide, and troubleshooting
133+
- Add site-template contributor section to `CONTRIBUTING.md`
134+
135+
### npm Workspace Audit
136+
- Docker and Home Lab already have `mcp-server/package.json` and publish workflows
137+
- Docker uses OIDC-based provenance publishing
138+
- Home Lab uses `NPM_TOKEN` secret
139+
- Standardize on one approach
140+
- Confirm Steam (plugin-only) and Monday (Python-based) don't need npm
141+
- Verify `registry.json` npm fields are accurate
142+
143+
---
144+
145+
## Completed
146+
147+
- [x] `registry.json` schema with 10 registered tools and full CI validation
148+
- [x] Standards documentation (CI/CD, GitHub Pages, repo structure, versioning)
149+
- [x] Scaffold generator (`create-tool.py`) with Jinja2 templates
150+
- [x] GitHub Pages catalog site (`docs/index.html`)
151+
- [x] CodeQL, dependency review, stale issue, label sync, release-drafter workflows
152+
- [x] `AGENTS.md`, `CLAUDE.md`, `CONTRIBUTING.md`, `SECURITY.md`, `CODE_OF_CONDUCT.md`
153+
- [x] Repository logo (`assets/logo.png`)
154+
- [x] Unified site template (`site-template/`) with `build_site.py` and `template.html.j2`
155+
- [x] Self-hosted fonts (Inter, JetBrains Mono)
156+
- [x] Collapsible sections, search/filter, copy buttons, toast, back-to-top
157+
- [x] Hero logo, accent glow, light/dark mode, expand animations, rich footer
158+
- [x] Scaffold updated for unified template (`pages.yml.j2`, `site.json.j2`, `mcp-tools.json.j2`)
159+
- [x] All 4 tool repos deployed with unified site template
160+
- [x] `AGENTS.md` created in all 4 tool repos
161+
- [x] Monday CI workflow and dependency-review workflow added
162+
- [x] Monday README badges made clickable
163+
164+
---
165+
166+
## Release Process
167+
168+
1. Implement all items for the milestone
169+
2. Update `registry.json` if tool metadata changed
170+
3. Run `validate.yml` CI (schema validation + scaffold dry-run)
171+
4. Rebuild all affected tool repo sites locally and verify
172+
5. Update `CHANGELOG.md` and this file
173+
6. Commit, tag, push, create GitHub release
174+
7. Trigger `pages.yml` deploys for affected tool repos
175+
176+
---
177+
178+
## Contributing
179+
180+
Have an idea for a new standard, template feature, or tool integration? Check the [Contributing Guide](CONTRIBUTING.md) and open an issue or pull request.

0 commit comments

Comments
 (0)