Portfolio Site Roadmap

Overview

This document tracks all outstanding work items for the project, organized by type and linked to parent epics where applicable.

Status Legend

⬜ = Backlog (requires refinement)

🟦 = Todo (not started)

🟨 = In Progress (currently working on)

🟪 = Done (completed)

Epics

🟪 Content Creation and Documentation - Create all written content for the site including README, blog posts, and project documentation

⬜ Gitflow Implementation with GitHub Actions - Implement complete gitflow branching strategy with automated workflows

⬜ Multi-Environment Deployment - Set up separate deployment environments with preview capabilities

⬜ External API Migration (Phase 2) - Move markdown files and JSON data to external API

Tasks - Content Creation Epic

🟪 SPIKE - What Makes a good blog post - Research to inform structure and tone

🟪 Write README content - Create comprehensive README.md with overview, setup, tech stack

🟪 Implement README rendering on homepage - Add markdown parser and render README on homepage

🟪 Write portfolio misison statement - About section of read me and inital blog post outlining purpose and methodology in regards to delievery and technical decisions

🟪 Write post - Experience Page - List of work experience detail, dates, company, role and a list of achievements

🟪 Add Project roadmap page - Write todo file and render on project roadmap page

🟪 Simplify TODO.md document - Update todo file to be more succinct

🟪 Update experience page with feedback - Implement content recomendations from cv on the experience page

🟪 Write post - Tech decisions - Document architecture decisions, purpose, and learnings

🟪 Write post - Non-fiction writers site - Post about other website project

Tasks - Code Improvements (No Epic)

⬜ Audit file naming conventions - Review codebase and document naming inconsistencies

⬜ Standardize file naming casing - Rename files to follow convention, update imports

🟪 Remove unused code - Remove code bloat from next blog starter project

Tasks - Features Phase 1 (No Epic)

⬜ Design footer structure and content - Define footer sections, content, and layout

⬜ Implement footer component - Build responsive footer component

⬜ Create GitHub API integration service - Set up service to fetch issues from GitHub API

⬜ Build issues display component - Create UI to display active issues with status

⬜ Implement dynamic root navigation - Replace hardcoded nav with dynamic function

⬜ Implement feedback form - Formal way to submit website feedback

Tasks - Gitflow Epic

⬜ Document gitflow branching strategy - Create docs for branch naming, merge strategies, PR requirements

⬜ Create develop branch and protection rules - Set up develop branch with branch protection

⬜ Build GitHub Action for feature branches - Workflow for linting, tests, build validation

⬜ Build GitHub Action for develop branch - Workflow for staging deployment with tests

⬜ Build GitHub Action for release branches - Workflow for version bumping, changelog, testing

⬜ Build GitHub Action for main branch - Production deployment with tags and releases

⬜ Create hotfix workflow - Emergency hotfix workflow for fast-track to prod

Tasks - Multi-Environment Epic

⬜ Research preview environment options - Compare GitHub Pages, Netlify, Vercel, Cloudflare

⬜ Setup staging/dev deployment - Configure separate deployment for develop branch

⬜ Create GitHub Action for develop - preview Auto-deploy to staging on develop merge

⬜ Implement PR preview deployments - Ephemeral preview URLs for feature branch PRs

⬜ Configure environment-specific settings - Set up env vars and config for each environment

⬜ Update issue auto-close workflow - Manage issue lifecycle with gitflow properly

⬜ Document deployment process - Create docs for environments, workflow, rollback

Spikes

⬜ Research preview environment options

⬜ Research and compare deployment options

⬜ External API architecture research - Research API options, create POC, estimate effort

Tasks - Phase 2 External API Epic

⬜ SPIKE - External API architecture - Research API options and create proof of concept

⬜ Design external API structure Design endpoints, data models, auth strategy

⬜ Setup external API infrastructure Set up hosting, CI/CD, environment config TBD

⬜ Migrate markdown files to API Move markdown content and implement endpoints TBD

⬜ Migrate JSON data to API Move JSON data and implement endpoints TBD

⬜ Update frontend to consume API Refactor frontend for API consumption with caching TBD ,

⬜ Testing and performance optimization E2E testing, performance testing, optimization TBD

Labels Guide

Type Labels

  • epic - Parent tracking issue
  • task - Standard development work
  • spike - Research/investigation
  • bug - Something broken
  • enhancement - Improvement to existing feature

Domain Labels

  • ci-cd - CI/CD and automation
  • devops - Infrastructure and deployment
  • content - Written content
  • documentation - Technical docs
  • api - API-related work
  • ui - User interface
  • code-improvement - Refactoring/tech debt
  • infrastructure - Infrastructure setup
  • design - Design work

Notes

  • Update from ⬜ to 🟨 when you have refined an issue
  • Update from ⬜ to 🟨 when you start working on an issue
  • Update from 🟨 to 🟪 when you complete an issue
  • Time-box limits on spikes are strict to prevent scope creep
  • All dependencies should be completed before starting dependent tasks