Skip to content

feat: Phase 6 — documentation, PNG icons, and PWA polish#7

Merged
bakodramane merged 2 commits into
mainfrom
phase/6-docs
Jun 4, 2026
Merged

feat: Phase 6 — documentation, PNG icons, and PWA polish#7
bakodramane merged 2 commits into
mainfrom
phase/6-docs

Conversation

@bakodramane

Copy link
Copy Markdown
Owner

Summary

  • Generate PNG icons via @vite-pwa/assets-generator (replaces SVG placeholders); Lighthouse 11 PWA score rises from 88 → 100
  • Repository made public (satisfies MIT open-source requirement); GitHub Pages enabled and deploy workflow updated with workflow_dispatch
  • All four Phase 6 documentation tasks completed: README.md, CONTRIBUTING.md, docs/adding-a-method.md, docs/stata-v14-notes.md
  • DOI / stable URL added to every reference entry across all 16 catalogue files

Pre-tasks completed

Task Result
Lighthouse PWA ≥ 90 ✅ Score = 100 (after PNG icon fix)
PNG icons generated ✅ 64×64, 192×192, 512×512, maskable-512, apple-touch-180, favicon.ico
SVG refs replaced vite.config.ts manifest + index.html apple-touch-icon

Acceptance criteria

  • docs/adding-a-method.md complete with field reference table and worked example
  • docs/stata-v14-notes.md covers all 16 methods
  • README has live URL and quick-start instructions
  • npm run build passes
  • npm test passes (430/430)
  • npm run lint passes
  • v1.0.0 tag — will be applied to main after this PR is merged

Test plan

  • Review docs/adding-a-method.md — can a non-developer follow the guide alone?
  • Review docs/stata-v14-notes.md — are all 16 methods covered correctly?
  • Verify npm run build && npm test on the branch
  • After merge: confirm GitHub Pages deploys successfully
  • After merge: apply git tag v1.0.0 && git push origin v1.0.0

🤖 Generated with Claude Code

bakodramane and others added 2 commits June 4, 2026 15:04
Pre-tasks:
- Install @vite-pwa/assets-generator; generate PNG icons (64, 192, 512,
  maskable-512, apple-touch-180, favicon.ico) from SVG source
- Replace SVG icon references in vite.config.ts manifest and index.html
  with generated PNGs; add apple-touch-icon link
- Add workflow_dispatch trigger to deploy.yml; enable GitHub Pages (repo
  made public per open-source requirement)
- Lighthouse 11 PWA score: 100/100 (was 88 before PNG icons)

Documentation (Phase 6 tasks):
- README.md: full quick-start, project structure, deploy notes, links
- CONTRIBUTING.md: code of conduct stub, PR guide, coding conventions
- docs/adding-a-method.md: step-by-step guide with field reference table
  and worked example (spatio-temporal FH)
- docs/stata-v14-notes.md: v14 compatibility for all 16 methods with
  fallback details and R alternatives

Catalogue reference URLs (task 5):
- Add DOI or stable URL to every reference entry across all 16 catalogue
  files where a URL could be confirmed

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@bakodramane bakodramane merged commit 4b538dc into main Jun 4, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant