Getting Started for Engineers

This guide helps developers, automation specialists, and technical builders showcase their work. Focus on demonstrating technical expertise through projects, workflows, and GitHub integration.

Your Goal

Build a technical portfolio that:

  • Showcases real projects with code
  • Demonstrates automation expertise through workflows
  • Shows GitHub activity and contributions
  • Highlights your tech stack and skills

Time Investment

About 25 minutes to set up a technical portfolio.


Step 1: Connect GitHub

Start by linking your GitHub presence.

Set Up GitHub Integration

  1. Go to Settings > Connections
  2. Click Connect GitHub
  3. Authorize the requested permissions
  4. Your GitHub account is now linked

What This Enables

  • Import repositories as projects
  • Display pull request activity
  • Show commit history
  • Track issues and contributions

Step 2: Create Technical Projects

From GitHub Repositories

For existing repos:

  1. Create a new Project
  2. Go to the Repos tab
  3. Click Connect Repository
  4. Select your repo

The project now displays:

  • Recent commits
  • Open and merged PRs
  • Issue activity
  • Contributor stats

Project Best Practices

For each project, add:

FieldWhat to Include
DescriptionWhat it does, why you built it, technical approach
Tech StackLanguages, frameworks, tools used
Result BlurbImpact or achievement (e.g., "10k+ npm downloads")

Example Project Description

A CLI tool for generating TypeScript types from JSON schemas. **Why I built it:** Tired of manually creating type definitions for API responses. **Technical approach:** - Parses JSON Schema draft-07 - Generates strict TypeScript interfaces - Handles nested objects and arrays - Supports custom type mappings **Stack:** TypeScript, Node.js, Commander.js

Step 3: Showcase Automation Workflows

If you build automations, showcase them:

Upload n8n Workflows

  1. Go to Settings > Workflows
  2. Click Upload Workflow
  3. Select your .json workflow file
  4. Add metadata:
FieldExample
TitleGitHub to Slack Notifications
DescriptionPosts PR updates to team channel
CategoryDevOps
Tagsgithub, slack, notifications

Document Your Workflows

For each workflow, include:

  • What it automates — The manual process it replaces
  • Trigger — What kicks it off
  • Steps — Key actions in the workflow
  • Output — What happens when it runs

Example Workflow Description

Automates GitHub PR notifications to Slack. **Trigger:** New PR opened or merged **Process:** 1. Webhook receives GitHub event 2. Filters by repository and event type 3. Formats message with PR details 4. Posts to #engineering channel **Result:** Team stays informed without checking GitHub constantly. Saves ~15 minutes per developer per day.

Step 4: Organize Your Work

Use Projects Effectively

Create projects for:

  • Open source libraries — Show your contributions
  • Side projects — Demonstrate initiative and learning
  • Client work — Showcase professional experience (if shareable)
  • Learning projects — Document your growth

Track with Tasks

Use tasks to manage:

  • Bug fixes and features
  • Documentation updates
  • Release planning
  • Technical debt

Step 5: Set Up Your Profile

Technical Profile Essentials

  1. Go to Settings > Profile
  2. Configure:
FieldRecommendation
UsernameYour GitHub username or personal brand
Display NameYour name
BioTechnical focus, current interests, stack
GitHubLink to your GitHub profile

Example Technical Bio

Full-stack engineer building tools for developers. Currently working with TypeScript, Next.js, and PostgreSQL. Interested in developer experience, automation, and open source. Previously: Senior Engineer at [Company], core contributor to [Project].

Enable Content Sections

Toggle these in profile settings:

  • Show Projects — Display your technical projects
  • Show Workflows — Display automation templates

Step 6: Make Work Public

Publish Projects

For projects you want to showcase:

  1. Open project Settings
  2. Toggle Public to ON
  3. Ensure Tech Stack and Result Blurb are filled in

Set Workflow Visibility

For workflows:

  1. Go to Settings > Workflows
  2. Click on a workflow
  3. Set Visibility to Public or Unlisted

Add CTAs (Optional)

If you want inquiries:

  1. Enable Hero CTA
  2. Label: "View Resume" or "Hire Me"
  3. Link to your resume or contact page

Technical Portfolio Checklist

Profile Setup

  • GitHub account connected
  • Username and bio configured
  • GitHub profile linked in social links
  • Profile visibility enabled

Projects

  • At least 2-3 projects created
  • GitHub repos connected to relevant projects
  • Tech stack tags added to each project
  • Clear descriptions explaining technical approach
  • Projects marked as public

Workflows (if applicable)

  • Key workflows uploaded
  • Each workflow has description and tags
  • Visibility set appropriately

Advanced Tips

Highlight Technical Depth

Don't just list what you built—explain how:

Surface level: "Built a REST API"
With depth: "Built a REST API with rate limiting, request validation via Zod, and automatic OpenAPI documentation generation"

Show Problem-Solving

Document your thought process:

  • What problem were you solving?
  • What approaches did you consider?
  • Why did you choose this solution?
  • What would you do differently?

Keep Tech Stack Current

Update your project tech stacks when you:

  • Add new technologies
  • Upgrade major versions
  • Refactor to new patterns

Link workflows to projects they support:

  1. Open a workflow's settings
  2. Use Link Project to associate
  3. Both pages now cross-reference

Workflow Ideas for Engineers

If you need workflow inspiration:

Use CaseDescription
CI/CD NotificationsAlert Slack when builds fail
Issue TriageAuto-label GitHub issues by content
PR AutomationAuto-assign reviewers, add labels
Release NotesGenerate changelogs from commits
Dependency UpdatesMonitor and alert on outdated deps
Documentation SyncUpdate docs when code changes

Next Steps


Common Questions

Can I display private GitHub repos?

The platform respects GitHub permissions. You can connect private repos, but activity from them won't show publicly. You can still use them for internal project tracking.

How do workflows appear on my profile?

Public workflows display in a dedicated section showing title, category, and description. Visitors can view details and download (for uploaded workflows).

What if my best work is proprietary?

  • Create anonymized case studies
  • Focus on the technical approach, not specific details
  • Describe the stack and challenges without revealing sensitive info
  • Use personal projects to demonstrate skills you can't show from work

How often should I update my portfolio?

  • Add new projects when you ship something meaningful
  • Update tech stacks when you learn new technologies
  • Review quarterly to ensure everything is current
Was this page helpful?
For Engineers | Documentation | DoerPath