Skip to content

docs: expand onboarding guide with setup steps and designer workflow#3683

Open
devin-ai-integration[bot] wants to merge 2 commits intomainfrom
devin/1770354199-onboarding-handbook
Open

docs: expand onboarding guide with setup steps and designer workflow#3683
devin-ai-integration[bot] wants to merge 2 commits intomainfrom
devin/1770354199-onboarding-handbook

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Feb 6, 2026

Summary

Expands the previously sparse onboarding page in the company handbook (how-we-work/5.onboarding.mdx) with practical getting-started steps. The old page had empty GitHub/Cursor sections and only staging build info. Now includes:

  • First Steps checklist (GitHub access, Infisical invite, read handbook, read dev docs, download staging build, set up dev env)
  • Development Environment section with editor recommendation, quick-start repo setup for Mac/Linux, and Cursor troubleshooting tips
  • Local Supabase and Auth section explaining that local Supabase (Docker) is used during dev, and how to use Infisical to inject dev-only GitHub OAuth credentials for login
  • For Designers section covering what to explore first, the Figma-to-code workflow, key directories for UI work, and how to contribute to content/docs

Existing staging build download/trigger sections are preserved unchanged.

Updates since last revision

Based on a Slack thread where a new team member didn't realize dev docs existed and couldn't log in (expecting production Supabase keys):

  • Added Infisical invite as step 2 in First Steps
  • Added explicit "read the developer documentation" as step 4 in First Steps
  • Added new Local Supabase and Auth subsection clarifying: no production keys needed, task supabase-start generates everything, and the infisical run --env=dev ... command enables GitHub OAuth locally
  • Added a tip callout at the end of Troubleshooting pointing to the developer docs hub

Review & Testing Checklist for Human

  • Verify the Infisical project ID is correct — The command infisical run --env=dev --projectId=87dad7b5-72a6-4791-9228-b3b86b169db1 --path="/supabase" -- task supabase-start was taken from a comment in the Taskfile. Confirm this project ID is correct and appropriate to publish in docs.
  • Verify internal links resolve correctly — The page now links to /docs/developers/login in addition to /docs/developers/setup, /docs/developers/env, /docs/developers/run, /handbook/about/what-hyprnote-is, /handbook/beliefs/design-philosophy, /handbook/about/product-philosophy, and /handbook/how-we-work/cms. Check these on the preview deployment.
  • Review "For Designers" section for accuracy — The design-to-code workflow (Figma → Slack → code → PR) was inferred from team context. Confirm this matches the actual intended workflow.
  • Check that the setup commands are current — The Mac/Linux quick-start steps were pulled from the existing developer docs. Verify nothing is outdated.

Notes

Requested by @ComputelessComputer
Link to Devin run

Co-Authored-By: john@hyprnote.com <john@hyprnote.com>
@netlify
Copy link

netlify bot commented Feb 6, 2026

Deploy Preview for hyprnote-storybook canceled.

Name Link
🔨 Latest commit 42e7628
🔍 Latest deploy log https://app.netlify.com/projects/hyprnote-storybook/deploys/6985887155cc790008cf9960

@netlify
Copy link

netlify bot commented Feb 6, 2026

Deploy Preview for hyprnote failed.

Name Link
🔨 Latest commit 42e7628
🔍 Latest deploy log https://app.netlify.com/projects/hyprnote/deploys/69858871ee79480008b1f009

@devin-ai-integration
Copy link
Contributor Author

Prompt hidden (unlisted session)

@devin-ai-integration
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR that start with 'DevinAI' or '@devin'.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

…rding

Co-Authored-By: john@hyprnote.com <john@hyprnote.com>
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