slopus / slopus/slopus.github.io

Self-hosting docs are outdated and point to legacy `happy-server` setup?

Open Beginner friendly
#22 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
MDX
Stars
18
Forks
22
PR merge metrics
No merged PRs in 30d

Description

The self-hosting guide appears to be outdated:

https://happy.engineering/docs/guides/self-hosting/

Current issues I noticed:

It tells users to clone https://github.com/slopus/happy-server, but the current server code lives in the main monorepo: https://github.com/slopus/happy.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the self-hosting guide at https://happy.engineering/docs/guides/self-hosting/ and check where it references the legacy happy-server repository. Update the setup instructions to point to the server code in the https://github.com/slopus/happy monorepo; done means the guide no longer directs users to the legacy repository.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
74/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.