Portfolio Maintenance

Portfolio Maintenance Skill

This repository serves as the portfolio of Yuichi Yogo, showcasing various creative coding experiments and prototypes. This skill helps maintain and update the portfolio documentation consistently.

Core Principles

1. Project Organization

• Use hierarchical headings for clear organization (H2 for categories, H3 for projects)
• Group projects by technology stack (e.g. Audio/WebGL/Graphics)
• Focus on technical implementation details in descriptions
• After adding or updating entries, regenerate the table of contents:

  npx markdown-toc -i README.md
  

2. Repository Structure

The portfolio uses git submodules to manage individual projects. When adding a new project:

# 1. Create a new directory under prototypes/
# 2. Add the project as a submodule
git submodule add https://github.com/yuichkun/<project-name> prototypes/<local-name>

# Example: Image Tessellation project
git submodule add https://github.com/yuichkun/mosaic-by-image-gathering prototypes/image-tessellation

3. Asset Management

Always use absolute GitHub URLs for assets from submodules:

<!-- Good -->
![](https://raw.githubusercontent.com/yuichkun/repo-name/main/image.gif)

<!-- Bad -->
![](./prototypes/project/image.gif)

Project Entry Format

Use this template for new project entries:

### Project Name
![Project Demo](URL-to-demo-gif)

[🔗 Demo](URL) • [📝 Learn more](URL)

Technical description of the project, focusing on implementation details,
technologies used, and unique features.

Example Entry

### Single Motion Granular
![](https://raw.githubusercontent.com/yuichkun/kentaro-granular-web/master/single-motion-granular.gif)

[🔗 Demo](https://kentaro-granular-web.vercel.app) • [📝 Learn more](https://github.com/yuichkun/kentaro-granular-web/blob/master/README.md)

A granular synthesis experiment with an intuitive XY pad interface. Transform audio
samples into rich, evolving textures through fluid motion control. Built with RNBO,
featuring DSP by [kentaro tools](https://kentaro.tools).

Workflow for Adding Projects

When the user asks to add a project to the portfolio:

1. Gather Information

   • Project repository URL
   • Local directory name under prototypes/
   • Demo URL (if available)
   • GIF/image URL for demonstration
   • Technical description

2. Add Submodule

   • Use the git submodule command pattern above
   • Commit the submodule addition

3. Update README.md

   • Find the appropriate category section
   • Add the project entry following the format template
   • Use absolute GitHub URLs for all assets

4. Regenerate TOC

   • Run npx markdown-toc -i README.md
   • Commit the changes

5. Review

   • Check that links work
   • Verify formatting is consistent
   • Ensure technical description is clear and detailed

Quality Checklist

Before completing portfolio maintenance tasks, verify:

• All asset URLs are absolute GitHub URLs
• Project entry follows the template format
• Technical description focuses on implementation details
• Demo and repository links are working
• Entry is in the correct category section
• Table of contents has been regenerated
• All changes are committed