Skip to content

docs: v2.0 docs rewrite and GitHub Pages landing page#1

Closed
cyberwalk3r wants to merge 15 commits into
mainfrom
docs/v2-docs-and-github-pages
Closed

docs: v2.0 docs rewrite and GitHub Pages landing page#1
cyberwalk3r wants to merge 15 commits into
mainfrom
docs/v2-docs-and-github-pages

Conversation

@cyberwalk3r
Copy link
Copy Markdown
Owner

@cyberwalk3r cyberwalk3r commented Mar 6, 2026

Summary

  • CHANGELOG.md — adds v2.0 entry documenting new skills, redesigned agents, state-aware system, and multi-format output
  • CONTRIBUTING.md — full rewrite with v2 conventions: state-aware pattern, shared references, agent tool boundaries, return contracts
  • README.md — full narrative rewrite with badges, all 15 skills grouped by workflow phase, v2 highlights, and founder voice
  • docs/index.html + docs/style.css — GitHub Pages landing page: dark terminal aesthetic, amber accent, typewriter hero animation, 15 command cards, 3 agent cards, install section

GitHub Pages activation (manual step)

After merge, enable GitHub Pages in repo Settings → Pages → Branch: main, folder: /docs.

Site will be live at https://cyberwalk3r.github.io/qa-toolkit/.

Test plan

  • Verify all 15 skills listed in README and site match actual skills in skills/
  • Check docs/index.html renders correctly in browser (dark theme, animations, copy button)
  • Confirm CHANGELOG v2.0 entry is above v1.1.0 and formatting matches
  • Confirm CONTRIBUTING.md state-aware pattern section is accurate vs skills/shared/references/state-integration.md

cyberwalk3r added 13 commits March 6, 2026 23:15
@cyberwalk3r
docs: add design doc for v2.0 docs rewrite and GitHub Pages
bda32d1 
Signed-off-by: Himanshu Vimal <himanshu.vimal@gmail.com>
@cyberwalk3r
docs: add implementation plan for docs rewrite and GitHub Pages
2c24aef 
Signed-off-by: Himanshu Vimal <himanshu.vimal@gmail.com>
@cyberwalk3r
docs: add v2.0 changelog entry
c79c6b3 
Signed-off-by: Himanshu Vimal <himanshu.vimal@gmail.com>
@cyberwalk3r
docs: rewrite CONTRIBUTING for v2 conventions and friendlier tone
9ed1d38 
Signed-off-by: Himanshu Vimal <himanshu.vimal@gmail.com>
@cyberwalk3r
docs: rewrite README for v2.0 with new narrative and all 15 skills
8186c38 
Signed-off-by: Himanshu Vimal <himanshu.vimal@gmail.com>
@cyberwalk3r
feat: add GitHub Pages site with landing page and full command reference
9374d38 
Signed-off-by: Himanshu Vimal <himanshu.vimal@gmail.com>
@cyberwalk3r
docs: fix AI slop — remove fake quotes, sharpen voice, make claims sp…
63ffd81 
…ecific

Signed-off-by: Himanshu Vimal <himanshu.vimal@gmail.com>
@cyberwalk3r
feat: add favicon, og:image and social meta tags to GitHub Pages site
e90da6a 
Signed-off-by: Himanshu Vimal <himanshu.vimal@gmail.com>
@cyberwalk3r
fix: scope permissions, bump plugin version to 2.0.0, remove dead sav…
0788d4e 
…e-artifact.js

Signed-off-by: Himanshu Vimal <himanshu.vimal@gmail.com>
@cyberwalk3r
fix: remove legacy .qa-config.json dual-write and all stale references
a84f61e 
- Remove legacyConfigPath, legacyConfig write from detect-project.js
- Drop .qa-config.json fallback from cold-start-pattern.md
- Update all docs (README, CLAUDE.md, CONTRIBUTING.md) to .qa-context.json
- Fix stale save-artifact.js reference in hooks-toggle.test.js -> session-hook.js
- Update test assertions and helper to read .qa-context.json
- All 22 tests passing

Signed-off-by: Himanshu Vimal <himanshu.vimal@gmail.com>
@cyberwalk3r
docs: redesign landing page — new hero, animations, readability overhaul
4b6534c 
- New headline: "Test the code. Trust the release."
- Swirling particle vortex in hero, CSS background effects per section
  (aurora, light-sweep, radial-pulse, shimmer-line)
- Scroll animations: one-way reveal (removed exit animations that blanked page)
- Reordered hero: terminal above stats, bigger stat numbers with glow
- Readability: switched all body text from muted gray to white, bumped
  font sizes across cards/labels/subtitles, removed artificial max-widths
- Consistent Inter font for headings (replaced Syne display font)
- Removed unused docs/assets/ directory (19MB of unreferenced files)
- Tightened section padding, widened card grid minimums

Signed-off-by: Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: Himanshu Vimal <himanshu.vimal@gmail.com>
@cyberwalk3r
docs: update skill descriptions and settings
c53d931 
Signed-off-by: Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: Himanshu Vimal <himanshu.vimal@gmail.com>
@cyberwalk3r
docs: add workflow diagram, quick start guide, fix stale references
59dfdb9 
- Add Mermaid workflow diagram to README and GitHub Pages site
- Add Quick Start section with recommended first command and workflow
- Add agent selection guidance (when to use agents vs skills)
- Fix plugin.json description (10 → 15 skills)
- Fix CLAUDE.md skill count and stale save-artifact.js reference
- Fix CHANGELOG.md .qa-config.json → .qa-context.json references
- Fix artifact-organization.md save-artifact.js → session-hook.js

Signed-off-by: Himanshu Vimal <himanshu.vimal@gmail.com>
@cyberwalk3r
Copy link
Copy Markdown
Owner Author

cyberwalk3r commented Mar 6, 2026

Added: Workflow diagram, quick start, stale reference fixes

New content

  • Mermaid workflow diagram in README (GitHub-native rendering) and GitHub Pages site (mermaid.js with dark theme)
  • Quick Start section in README — install → setup → first command → gitignore tip
  • Agent selection callout — when to pick each agent vs. the corresponding skill
  • Workflow section on GitHub Pages between "How It Works" and "Commands"

Stale docs fixed

  • plugin.json description: "10 skills" → "15 QA skills and 3 agent personas"
  • CLAUDE.md: skill count 10 → 15, removed dead save-artifact.js reference
  • CHANGELOG.md: .qa-config.json → .qa-context.json (2 occurrences)
  • artifact-organization.md: save-artifact.js → session-hook.js

@cyberwalk3r
docs: fix permissions docs, remove shipped .claude/, add dry-run and …
8e8a7aa 
…budget docs

- Remove .claude/settings.local.json — plugins should not ship user-local
  settings; permissions are approved interactively on first use
- Rewrite README Permissions section to describe interactive approval
- Document --dry-run flag for detect-project.js in README and CONTRIBUTING
- Document skill budget validator in CONTRIBUTING and add to CI
- Add session end summary output to session-hook.js
- Move test file from scripts/ to tests/
- Add CHANGELOG entry for v2.0.1

Signed-off-by: nerd <nerd@localhost>
Signed-off-by: Himanshu Vimal <himanshu.vimal@gmail.com>
@cyberwalk3r
fix: stale docs, log rotation, author metadata
5d848be 
- Fix artifact directory names in README (coverage-gaps → coverage-analysis,
  risk-analyses → risk-analysis, flaky-diagnoses → flaky-diagnosis, add
  missing exploratory/)
- Fix .qa-context.json schema table to show actual nested structure
  (detection.* sub-fields, not flat top-level)
- Add settings.json schema table and detection limitations section
- Add activity log rotation at 512 KB in session-hook.js
- Update CLAUDE.md skill description convention to match reality (1-3
  sentences, not one)
- Fix author metadata to cyberwalk3r in plugin.json and LICENSE

Signed-off-by: nerd <nerd@localhost>
Signed-off-by: Himanshu Vimal <himanshu.vimal@gmail.com>
@cyberwalk3r
Copy link
Copy Markdown
Owner Author

cyberwalk3r commented Mar 7, 2026

Changes already squash-merged directly into main (6dce4bc → 3b5402e after history cleanup). Closing stale PR.

@cyberwalk3r cyberwalk3r closed this Mar 7, 2026
@cyberwalk3r cyberwalk3r deleted the docs/v2-docs-and-github-pages branch March 7, 2026 01:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@cyberwalk3r